Classify companies
curl --request POST \
--url https://global-api.thedatacity.com/v1/fr/classification \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"NAFs": [
"<string>"
],
"Name": "<string>",
"Country": "<string>",
"EmployeeRange": "<string>",
"LegalForm": "<string>",
"LegalForms": [
"<string>"
],
"HQPostcode": "<string>",
"Commune": [
"<string>"
],
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": true,
"OperatingLocationAddresses": [
"<string>"
],
"OperatingLocationPostcodes": [
"<string>"
],
"OperatingLocationCommunes": [
"<string>"
],
"OperatingLocationNAFCodes": [
"<string>"
],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": [
"<string>"
],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"Includes": [
"<string>"
],
"Excludes": [
"<string>"
],
"HasWebText": true,
"IncludeInsights": true,
"IncludeTotalCount": true,
"IncludesLocations": true,
"Limit": 500,
"Offset": 1073741823,
"SortBy": [
{
"Field": "<string>",
"Direction": "<string>"
}
],
"Cutoff": 123,
"Yes": [
"<string>"
],
"No": [
"<string>"
],
"VerticalSeed": "<string>",
"UseTranslatedWebTextForYesNo": true,
"VerticalSeedNativeLanguageOnly": true,
"ManuallyInclude": [
"<string>"
],
"ManuallyExclude": [
"<string>"
]
}
'import requests
url = "https://global-api.thedatacity.com/v1/fr/classification"
payload = {
"NAFs": ["<string>"],
"Name": "<string>",
"Country": "<string>",
"EmployeeRange": "<string>",
"LegalForm": "<string>",
"LegalForms": ["<string>"],
"HQPostcode": "<string>",
"Commune": ["<string>"],
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": True,
"OperatingLocationAddresses": ["<string>"],
"OperatingLocationPostcodes": ["<string>"],
"OperatingLocationCommunes": ["<string>"],
"OperatingLocationNAFCodes": ["<string>"],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": ["<string>"],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"Includes": ["<string>"],
"Excludes": ["<string>"],
"HasWebText": True,
"IncludeInsights": True,
"IncludeTotalCount": True,
"IncludesLocations": True,
"Limit": 500,
"Offset": 1073741823,
"SortBy": [
{
"Field": "<string>",
"Direction": "<string>"
}
],
"Cutoff": 123,
"Yes": ["<string>"],
"No": ["<string>"],
"VerticalSeed": "<string>",
"UseTranslatedWebTextForYesNo": True,
"VerticalSeedNativeLanguageOnly": True,
"ManuallyInclude": ["<string>"],
"ManuallyExclude": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
NAFs: ['<string>'],
Name: '<string>',
Country: '<string>',
EmployeeRange: '<string>',
LegalForm: '<string>',
LegalForms: ['<string>'],
HQPostcode: '<string>',
Commune: ['<string>'],
DateOfIncorporation: '2023-12-25',
IncorporationDateFrom: '2023-12-25',
IncorporationDateTo: '2023-12-25',
HasWebsite: true,
OperatingLocationAddresses: ['<string>'],
OperatingLocationPostcodes: ['<string>'],
OperatingLocationCommunes: ['<string>'],
OperatingLocationNAFCodes: ['<string>'],
MinTurnover: 4611686018427388000,
MaxTurnover: 4611686018427388000,
MinEBIT: 0,
MaxEBIT: 0,
MinNetIncome: 0,
MaxNetIncome: 0,
FinancialYearEnding: 123,
MinFinancialYearEnding: 123,
MaxFinancialYearEnding: 123,
AccountsType: '<string>',
RTICs: ['<string>'],
LowerLatitude: 0,
UpperLatitude: 0,
LowerLongitude: 0,
UpperLongitude: 0,
Includes: ['<string>'],
Excludes: ['<string>'],
HasWebText: true,
IncludeInsights: true,
IncludeTotalCount: true,
IncludesLocations: true,
Limit: 500,
Offset: 1073741823,
SortBy: [{Field: '<string>', Direction: '<string>'}],
Cutoff: 123,
Yes: ['<string>'],
No: ['<string>'],
VerticalSeed: '<string>',
UseTranslatedWebTextForYesNo: true,
VerticalSeedNativeLanguageOnly: true,
ManuallyInclude: ['<string>'],
ManuallyExclude: ['<string>']
})
};
fetch('https://global-api.thedatacity.com/v1/fr/classification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://global-api.thedatacity.com/v1/fr/classification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'NAFs' => [
'<string>'
],
'Name' => '<string>',
'Country' => '<string>',
'EmployeeRange' => '<string>',
'LegalForm' => '<string>',
'LegalForms' => [
'<string>'
],
'HQPostcode' => '<string>',
'Commune' => [
'<string>'
],
'DateOfIncorporation' => '2023-12-25',
'IncorporationDateFrom' => '2023-12-25',
'IncorporationDateTo' => '2023-12-25',
'HasWebsite' => true,
'OperatingLocationAddresses' => [
'<string>'
],
'OperatingLocationPostcodes' => [
'<string>'
],
'OperatingLocationCommunes' => [
'<string>'
],
'OperatingLocationNAFCodes' => [
'<string>'
],
'MinTurnover' => 4611686018427388000,
'MaxTurnover' => 4611686018427388000,
'MinEBIT' => 0,
'MaxEBIT' => 0,
'MinNetIncome' => 0,
'MaxNetIncome' => 0,
'FinancialYearEnding' => 123,
'MinFinancialYearEnding' => 123,
'MaxFinancialYearEnding' => 123,
'AccountsType' => '<string>',
'RTICs' => [
'<string>'
],
'LowerLatitude' => 0,
'UpperLatitude' => 0,
'LowerLongitude' => 0,
'UpperLongitude' => 0,
'Includes' => [
'<string>'
],
'Excludes' => [
'<string>'
],
'HasWebText' => true,
'IncludeInsights' => true,
'IncludeTotalCount' => true,
'IncludesLocations' => true,
'Limit' => 500,
'Offset' => 1073741823,
'SortBy' => [
[
'Field' => '<string>',
'Direction' => '<string>'
]
],
'Cutoff' => 123,
'Yes' => [
'<string>'
],
'No' => [
'<string>'
],
'VerticalSeed' => '<string>',
'UseTranslatedWebTextForYesNo' => true,
'VerticalSeedNativeLanguageOnly' => true,
'ManuallyInclude' => [
'<string>'
],
'ManuallyExclude' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://global-api.thedatacity.com/v1/fr/classification"
payload := strings.NewReader("{\n \"NAFs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"EmployeeRange\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"Commune\": [\n \"<string>\"\n ],\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\n \"<string>\"\n ],\n \"OperatingLocationPostcodes\": [\n \"<string>\"\n ],\n \"OperatingLocationCommunes\": [\n \"<string>\"\n ],\n \"OperatingLocationNAFCodes\": [\n \"<string>\"\n ],\n \"MinTurnover\": 4611686018427388000,\n \"MaxTurnover\": 4611686018427388000,\n \"MinEBIT\": 0,\n \"MaxEBIT\": 0,\n \"MinNetIncome\": 0,\n \"MaxNetIncome\": 0,\n \"FinancialYearEnding\": 123,\n \"MinFinancialYearEnding\": 123,\n \"MaxFinancialYearEnding\": 123,\n \"AccountsType\": \"<string>\",\n \"RTICs\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"HasWebText\": true,\n \"IncludeInsights\": true,\n \"IncludeTotalCount\": true,\n \"IncludesLocations\": true,\n \"Limit\": 500,\n \"Offset\": 1073741823,\n \"SortBy\": [\n {\n \"Field\": \"<string>\",\n \"Direction\": \"<string>\"\n }\n ],\n \"Cutoff\": 123,\n \"Yes\": [\n \"<string>\"\n ],\n \"No\": [\n \"<string>\"\n ],\n \"VerticalSeed\": \"<string>\",\n \"UseTranslatedWebTextForYesNo\": true,\n \"VerticalSeedNativeLanguageOnly\": true,\n \"ManuallyInclude\": [\n \"<string>\"\n ],\n \"ManuallyExclude\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://global-api.thedatacity.com/v1/fr/classification")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"NAFs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"EmployeeRange\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"Commune\": [\n \"<string>\"\n ],\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\n \"<string>\"\n ],\n \"OperatingLocationPostcodes\": [\n \"<string>\"\n ],\n \"OperatingLocationCommunes\": [\n \"<string>\"\n ],\n \"OperatingLocationNAFCodes\": [\n \"<string>\"\n ],\n \"MinTurnover\": 4611686018427388000,\n \"MaxTurnover\": 4611686018427388000,\n \"MinEBIT\": 0,\n \"MaxEBIT\": 0,\n \"MinNetIncome\": 0,\n \"MaxNetIncome\": 0,\n \"FinancialYearEnding\": 123,\n \"MinFinancialYearEnding\": 123,\n \"MaxFinancialYearEnding\": 123,\n \"AccountsType\": \"<string>\",\n \"RTICs\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"HasWebText\": true,\n \"IncludeInsights\": true,\n \"IncludeTotalCount\": true,\n \"IncludesLocations\": true,\n \"Limit\": 500,\n \"Offset\": 1073741823,\n \"SortBy\": [\n {\n \"Field\": \"<string>\",\n \"Direction\": \"<string>\"\n }\n ],\n \"Cutoff\": 123,\n \"Yes\": [\n \"<string>\"\n ],\n \"No\": [\n \"<string>\"\n ],\n \"VerticalSeed\": \"<string>\",\n \"UseTranslatedWebTextForYesNo\": true,\n \"VerticalSeedNativeLanguageOnly\": true,\n \"ManuallyInclude\": [\n \"<string>\"\n ],\n \"ManuallyExclude\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://global-api.thedatacity.com/v1/fr/classification")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"NAFs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"EmployeeRange\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"Commune\": [\n \"<string>\"\n ],\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\n \"<string>\"\n ],\n \"OperatingLocationPostcodes\": [\n \"<string>\"\n ],\n \"OperatingLocationCommunes\": [\n \"<string>\"\n ],\n \"OperatingLocationNAFCodes\": [\n \"<string>\"\n ],\n \"MinTurnover\": 4611686018427388000,\n \"MaxTurnover\": 4611686018427388000,\n \"MinEBIT\": 0,\n \"MaxEBIT\": 0,\n \"MinNetIncome\": 0,\n \"MaxNetIncome\": 0,\n \"FinancialYearEnding\": 123,\n \"MinFinancialYearEnding\": 123,\n \"MaxFinancialYearEnding\": 123,\n \"AccountsType\": \"<string>\",\n \"RTICs\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"HasWebText\": true,\n \"IncludeInsights\": true,\n \"IncludeTotalCount\": true,\n \"IncludesLocations\": true,\n \"Limit\": 500,\n \"Offset\": 1073741823,\n \"SortBy\": [\n {\n \"Field\": \"<string>\",\n \"Direction\": \"<string>\"\n }\n ],\n \"Cutoff\": 123,\n \"Yes\": [\n \"<string>\"\n ],\n \"No\": [\n \"<string>\"\n ],\n \"VerticalSeed\": \"<string>\",\n \"UseTranslatedWebTextForYesNo\": true,\n \"VerticalSeedNativeLanguageOnly\": true,\n \"ManuallyInclude\": [\n \"<string>\"\n ],\n \"ManuallyExclude\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"Status": {
"Message": "<string>",
"ModelCode": "<string>",
"WordsWithNonZeroWeightsInClassifier": 123,
"SecondsSpentGettingTrainingData": 123,
"SecondsSpentTranslatingYesNoWebText": 123,
"SecondsSpentTrainingClassifier": 123,
"SecondsSpentClassifying": 123,
"SecondsSpentSavingClassificationResults": 123,
"SecondsSpentGettingCompanyDetails": 123,
"TotalCompaniesNowClassifiedForThisClassifier": 123,
"TotalCompaniesForClassification": 123
},
"CompaniesAboveCutoff": 123,
"CompaniesAboveCutoffMatchingFilters": 123,
"ModelCode": "<string>",
"WordScores": [
{
"Word": "<string>",
"Score": 123
}
],
"ScoreDistribution": [
{
"ID": "<string>",
"Name": "<string>",
"Count": 123,
"Children": "<array>"
}
],
"Results": [
{
"Name": "<string>",
"Siren": "<string>",
"Score": 123,
"Confidence": 123,
"WordsMatched": 123,
"CompanyURL": "<string>",
"WordScores": [
{
"Word": "<string>",
"Score": 123
}
],
"CompanyDetails": {
"Siren": "<string>",
"Name": "<string>",
"Website": "<string>",
"Description": "<string>",
"LegalForm": "<string>",
"EmployeeRange": "<string>",
"RTICs": [
{
"CompanyNumber": "<string>",
"SectorCode": "<string>",
"SectorName": "<string>",
"VerticalCode": "<string>",
"VerticalName": "<string>",
"Score": 123,
"WordsMatched": 123,
"Name": "<string>"
}
],
"LogoURL": "<string>",
"ScreenshotURL": "<string>",
"OperatingLocationsCount": 123,
"Country": "<string>",
"CommonName": "<string>",
"Acronym": "<string>",
"HQAddress": "<string>",
"HQPostcode": "<string>",
"HQPostcodeDetails": {
"code_commune_INSEE": "<string>",
"nom_commune_postal": "<string>",
"code_postal": "<string>",
"libelle_acheminement": "<string>",
"ligne_5": "<string>",
"latitude": 123,
"longitude": 123,
"code_commune": "<string>",
"article": "<string>",
"nom_commune": "<string>",
"nom_commune_complet": "<string>",
"code_departement": "<string>",
"nom_departement": "<string>",
"code_region": "<string>",
"nom_region": "<string>"
},
"HQCommune": "<string>",
"DateOfIncorporation": "2023-12-25",
"NAFSection": "<string>",
"NAFCodes": [
"<string>"
],
"NAFCode": "<string>",
"NAFName": "<string>",
"OperatingLocations": [
{
"Siret": "<string>",
"Address": "<string>",
"Postcode": "<string>",
"DateEstablished": "2023-12-25",
"IsRegisteredHQ": true,
"Commune": "<string>",
"NAFCode": "<string>",
"NAFName": "<string>",
"EmployeeRange": "<string>",
"Latitude": 123,
"Longitude": 123,
"PostcodeDetails": {
"code_commune_INSEE": "<string>",
"nom_commune_postal": "<string>",
"code_postal": "<string>",
"libelle_acheminement": "<string>",
"ligne_5": "<string>",
"latitude": 123,
"longitude": 123,
"code_commune": "<string>",
"article": "<string>",
"nom_commune": "<string>",
"nom_commune_complet": "<string>",
"code_departement": "<string>",
"nom_departement": "<string>",
"code_region": "<string>",
"nom_region": "<string>"
},
"ParentCompanyNumber": "<string>",
"ParentCompanyName": "<string>"
}
],
"FinancesByYear": [
{
"YearEnding": 123,
"AccountsDate": "2023-12-25",
"AccountsType": "<string>",
"Turnover": 123,
"EBIT": 123,
"NetIncome": 123,
"EmployeesHere": 123,
"EmployeesTotal": 123
}
],
"SimilarCompanies": [
{
"CompanyNumber": "<string>",
"SimilarityScore": 123
}
]
}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Classification
Classify companies
Runs the classification pipeline for the posted filter and training payload.
POST
/
v1
/
fr
/
classification
Classify companies
curl --request POST \
--url https://global-api.thedatacity.com/v1/fr/classification \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"NAFs": [
"<string>"
],
"Name": "<string>",
"Country": "<string>",
"EmployeeRange": "<string>",
"LegalForm": "<string>",
"LegalForms": [
"<string>"
],
"HQPostcode": "<string>",
"Commune": [
"<string>"
],
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": true,
"OperatingLocationAddresses": [
"<string>"
],
"OperatingLocationPostcodes": [
"<string>"
],
"OperatingLocationCommunes": [
"<string>"
],
"OperatingLocationNAFCodes": [
"<string>"
],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": [
"<string>"
],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"Includes": [
"<string>"
],
"Excludes": [
"<string>"
],
"HasWebText": true,
"IncludeInsights": true,
"IncludeTotalCount": true,
"IncludesLocations": true,
"Limit": 500,
"Offset": 1073741823,
"SortBy": [
{
"Field": "<string>",
"Direction": "<string>"
}
],
"Cutoff": 123,
"Yes": [
"<string>"
],
"No": [
"<string>"
],
"VerticalSeed": "<string>",
"UseTranslatedWebTextForYesNo": true,
"VerticalSeedNativeLanguageOnly": true,
"ManuallyInclude": [
"<string>"
],
"ManuallyExclude": [
"<string>"
]
}
'import requests
url = "https://global-api.thedatacity.com/v1/fr/classification"
payload = {
"NAFs": ["<string>"],
"Name": "<string>",
"Country": "<string>",
"EmployeeRange": "<string>",
"LegalForm": "<string>",
"LegalForms": ["<string>"],
"HQPostcode": "<string>",
"Commune": ["<string>"],
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": True,
"OperatingLocationAddresses": ["<string>"],
"OperatingLocationPostcodes": ["<string>"],
"OperatingLocationCommunes": ["<string>"],
"OperatingLocationNAFCodes": ["<string>"],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": ["<string>"],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"Includes": ["<string>"],
"Excludes": ["<string>"],
"HasWebText": True,
"IncludeInsights": True,
"IncludeTotalCount": True,
"IncludesLocations": True,
"Limit": 500,
"Offset": 1073741823,
"SortBy": [
{
"Field": "<string>",
"Direction": "<string>"
}
],
"Cutoff": 123,
"Yes": ["<string>"],
"No": ["<string>"],
"VerticalSeed": "<string>",
"UseTranslatedWebTextForYesNo": True,
"VerticalSeedNativeLanguageOnly": True,
"ManuallyInclude": ["<string>"],
"ManuallyExclude": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
NAFs: ['<string>'],
Name: '<string>',
Country: '<string>',
EmployeeRange: '<string>',
LegalForm: '<string>',
LegalForms: ['<string>'],
HQPostcode: '<string>',
Commune: ['<string>'],
DateOfIncorporation: '2023-12-25',
IncorporationDateFrom: '2023-12-25',
IncorporationDateTo: '2023-12-25',
HasWebsite: true,
OperatingLocationAddresses: ['<string>'],
OperatingLocationPostcodes: ['<string>'],
OperatingLocationCommunes: ['<string>'],
OperatingLocationNAFCodes: ['<string>'],
MinTurnover: 4611686018427388000,
MaxTurnover: 4611686018427388000,
MinEBIT: 0,
MaxEBIT: 0,
MinNetIncome: 0,
MaxNetIncome: 0,
FinancialYearEnding: 123,
MinFinancialYearEnding: 123,
MaxFinancialYearEnding: 123,
AccountsType: '<string>',
RTICs: ['<string>'],
LowerLatitude: 0,
UpperLatitude: 0,
LowerLongitude: 0,
UpperLongitude: 0,
Includes: ['<string>'],
Excludes: ['<string>'],
HasWebText: true,
IncludeInsights: true,
IncludeTotalCount: true,
IncludesLocations: true,
Limit: 500,
Offset: 1073741823,
SortBy: [{Field: '<string>', Direction: '<string>'}],
Cutoff: 123,
Yes: ['<string>'],
No: ['<string>'],
VerticalSeed: '<string>',
UseTranslatedWebTextForYesNo: true,
VerticalSeedNativeLanguageOnly: true,
ManuallyInclude: ['<string>'],
ManuallyExclude: ['<string>']
})
};
fetch('https://global-api.thedatacity.com/v1/fr/classification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://global-api.thedatacity.com/v1/fr/classification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'NAFs' => [
'<string>'
],
'Name' => '<string>',
'Country' => '<string>',
'EmployeeRange' => '<string>',
'LegalForm' => '<string>',
'LegalForms' => [
'<string>'
],
'HQPostcode' => '<string>',
'Commune' => [
'<string>'
],
'DateOfIncorporation' => '2023-12-25',
'IncorporationDateFrom' => '2023-12-25',
'IncorporationDateTo' => '2023-12-25',
'HasWebsite' => true,
'OperatingLocationAddresses' => [
'<string>'
],
'OperatingLocationPostcodes' => [
'<string>'
],
'OperatingLocationCommunes' => [
'<string>'
],
'OperatingLocationNAFCodes' => [
'<string>'
],
'MinTurnover' => 4611686018427388000,
'MaxTurnover' => 4611686018427388000,
'MinEBIT' => 0,
'MaxEBIT' => 0,
'MinNetIncome' => 0,
'MaxNetIncome' => 0,
'FinancialYearEnding' => 123,
'MinFinancialYearEnding' => 123,
'MaxFinancialYearEnding' => 123,
'AccountsType' => '<string>',
'RTICs' => [
'<string>'
],
'LowerLatitude' => 0,
'UpperLatitude' => 0,
'LowerLongitude' => 0,
'UpperLongitude' => 0,
'Includes' => [
'<string>'
],
'Excludes' => [
'<string>'
],
'HasWebText' => true,
'IncludeInsights' => true,
'IncludeTotalCount' => true,
'IncludesLocations' => true,
'Limit' => 500,
'Offset' => 1073741823,
'SortBy' => [
[
'Field' => '<string>',
'Direction' => '<string>'
]
],
'Cutoff' => 123,
'Yes' => [
'<string>'
],
'No' => [
'<string>'
],
'VerticalSeed' => '<string>',
'UseTranslatedWebTextForYesNo' => true,
'VerticalSeedNativeLanguageOnly' => true,
'ManuallyInclude' => [
'<string>'
],
'ManuallyExclude' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://global-api.thedatacity.com/v1/fr/classification"
payload := strings.NewReader("{\n \"NAFs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"EmployeeRange\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"Commune\": [\n \"<string>\"\n ],\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\n \"<string>\"\n ],\n \"OperatingLocationPostcodes\": [\n \"<string>\"\n ],\n \"OperatingLocationCommunes\": [\n \"<string>\"\n ],\n \"OperatingLocationNAFCodes\": [\n \"<string>\"\n ],\n \"MinTurnover\": 4611686018427388000,\n \"MaxTurnover\": 4611686018427388000,\n \"MinEBIT\": 0,\n \"MaxEBIT\": 0,\n \"MinNetIncome\": 0,\n \"MaxNetIncome\": 0,\n \"FinancialYearEnding\": 123,\n \"MinFinancialYearEnding\": 123,\n \"MaxFinancialYearEnding\": 123,\n \"AccountsType\": \"<string>\",\n \"RTICs\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"HasWebText\": true,\n \"IncludeInsights\": true,\n \"IncludeTotalCount\": true,\n \"IncludesLocations\": true,\n \"Limit\": 500,\n \"Offset\": 1073741823,\n \"SortBy\": [\n {\n \"Field\": \"<string>\",\n \"Direction\": \"<string>\"\n }\n ],\n \"Cutoff\": 123,\n \"Yes\": [\n \"<string>\"\n ],\n \"No\": [\n \"<string>\"\n ],\n \"VerticalSeed\": \"<string>\",\n \"UseTranslatedWebTextForYesNo\": true,\n \"VerticalSeedNativeLanguageOnly\": true,\n \"ManuallyInclude\": [\n \"<string>\"\n ],\n \"ManuallyExclude\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://global-api.thedatacity.com/v1/fr/classification")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"NAFs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"EmployeeRange\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"Commune\": [\n \"<string>\"\n ],\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\n \"<string>\"\n ],\n \"OperatingLocationPostcodes\": [\n \"<string>\"\n ],\n \"OperatingLocationCommunes\": [\n \"<string>\"\n ],\n \"OperatingLocationNAFCodes\": [\n \"<string>\"\n ],\n \"MinTurnover\": 4611686018427388000,\n \"MaxTurnover\": 4611686018427388000,\n \"MinEBIT\": 0,\n \"MaxEBIT\": 0,\n \"MinNetIncome\": 0,\n \"MaxNetIncome\": 0,\n \"FinancialYearEnding\": 123,\n \"MinFinancialYearEnding\": 123,\n \"MaxFinancialYearEnding\": 123,\n \"AccountsType\": \"<string>\",\n \"RTICs\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"HasWebText\": true,\n \"IncludeInsights\": true,\n \"IncludeTotalCount\": true,\n \"IncludesLocations\": true,\n \"Limit\": 500,\n \"Offset\": 1073741823,\n \"SortBy\": [\n {\n \"Field\": \"<string>\",\n \"Direction\": \"<string>\"\n }\n ],\n \"Cutoff\": 123,\n \"Yes\": [\n \"<string>\"\n ],\n \"No\": [\n \"<string>\"\n ],\n \"VerticalSeed\": \"<string>\",\n \"UseTranslatedWebTextForYesNo\": true,\n \"VerticalSeedNativeLanguageOnly\": true,\n \"ManuallyInclude\": [\n \"<string>\"\n ],\n \"ManuallyExclude\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://global-api.thedatacity.com/v1/fr/classification")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"NAFs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"EmployeeRange\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"Commune\": [\n \"<string>\"\n ],\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\n \"<string>\"\n ],\n \"OperatingLocationPostcodes\": [\n \"<string>\"\n ],\n \"OperatingLocationCommunes\": [\n \"<string>\"\n ],\n \"OperatingLocationNAFCodes\": [\n \"<string>\"\n ],\n \"MinTurnover\": 4611686018427388000,\n \"MaxTurnover\": 4611686018427388000,\n \"MinEBIT\": 0,\n \"MaxEBIT\": 0,\n \"MinNetIncome\": 0,\n \"MaxNetIncome\": 0,\n \"FinancialYearEnding\": 123,\n \"MinFinancialYearEnding\": 123,\n \"MaxFinancialYearEnding\": 123,\n \"AccountsType\": \"<string>\",\n \"RTICs\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"HasWebText\": true,\n \"IncludeInsights\": true,\n \"IncludeTotalCount\": true,\n \"IncludesLocations\": true,\n \"Limit\": 500,\n \"Offset\": 1073741823,\n \"SortBy\": [\n {\n \"Field\": \"<string>\",\n \"Direction\": \"<string>\"\n }\n ],\n \"Cutoff\": 123,\n \"Yes\": [\n \"<string>\"\n ],\n \"No\": [\n \"<string>\"\n ],\n \"VerticalSeed\": \"<string>\",\n \"UseTranslatedWebTextForYesNo\": true,\n \"VerticalSeedNativeLanguageOnly\": true,\n \"ManuallyInclude\": [\n \"<string>\"\n ],\n \"ManuallyExclude\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"Status": {
"Message": "<string>",
"ModelCode": "<string>",
"WordsWithNonZeroWeightsInClassifier": 123,
"SecondsSpentGettingTrainingData": 123,
"SecondsSpentTranslatingYesNoWebText": 123,
"SecondsSpentTrainingClassifier": 123,
"SecondsSpentClassifying": 123,
"SecondsSpentSavingClassificationResults": 123,
"SecondsSpentGettingCompanyDetails": 123,
"TotalCompaniesNowClassifiedForThisClassifier": 123,
"TotalCompaniesForClassification": 123
},
"CompaniesAboveCutoff": 123,
"CompaniesAboveCutoffMatchingFilters": 123,
"ModelCode": "<string>",
"WordScores": [
{
"Word": "<string>",
"Score": 123
}
],
"ScoreDistribution": [
{
"ID": "<string>",
"Name": "<string>",
"Count": 123,
"Children": "<array>"
}
],
"Results": [
{
"Name": "<string>",
"Siren": "<string>",
"Score": 123,
"Confidence": 123,
"WordsMatched": 123,
"CompanyURL": "<string>",
"WordScores": [
{
"Word": "<string>",
"Score": 123
}
],
"CompanyDetails": {
"Siren": "<string>",
"Name": "<string>",
"Website": "<string>",
"Description": "<string>",
"LegalForm": "<string>",
"EmployeeRange": "<string>",
"RTICs": [
{
"CompanyNumber": "<string>",
"SectorCode": "<string>",
"SectorName": "<string>",
"VerticalCode": "<string>",
"VerticalName": "<string>",
"Score": 123,
"WordsMatched": 123,
"Name": "<string>"
}
],
"LogoURL": "<string>",
"ScreenshotURL": "<string>",
"OperatingLocationsCount": 123,
"Country": "<string>",
"CommonName": "<string>",
"Acronym": "<string>",
"HQAddress": "<string>",
"HQPostcode": "<string>",
"HQPostcodeDetails": {
"code_commune_INSEE": "<string>",
"nom_commune_postal": "<string>",
"code_postal": "<string>",
"libelle_acheminement": "<string>",
"ligne_5": "<string>",
"latitude": 123,
"longitude": 123,
"code_commune": "<string>",
"article": "<string>",
"nom_commune": "<string>",
"nom_commune_complet": "<string>",
"code_departement": "<string>",
"nom_departement": "<string>",
"code_region": "<string>",
"nom_region": "<string>"
},
"HQCommune": "<string>",
"DateOfIncorporation": "2023-12-25",
"NAFSection": "<string>",
"NAFCodes": [
"<string>"
],
"NAFCode": "<string>",
"NAFName": "<string>",
"OperatingLocations": [
{
"Siret": "<string>",
"Address": "<string>",
"Postcode": "<string>",
"DateEstablished": "2023-12-25",
"IsRegisteredHQ": true,
"Commune": "<string>",
"NAFCode": "<string>",
"NAFName": "<string>",
"EmployeeRange": "<string>",
"Latitude": 123,
"Longitude": 123,
"PostcodeDetails": {
"code_commune_INSEE": "<string>",
"nom_commune_postal": "<string>",
"code_postal": "<string>",
"libelle_acheminement": "<string>",
"ligne_5": "<string>",
"latitude": 123,
"longitude": 123,
"code_commune": "<string>",
"article": "<string>",
"nom_commune": "<string>",
"nom_commune_complet": "<string>",
"code_departement": "<string>",
"nom_departement": "<string>",
"code_region": "<string>",
"nom_region": "<string>"
},
"ParentCompanyNumber": "<string>",
"ParentCompanyName": "<string>"
}
],
"FinancesByYear": [
{
"YearEnding": 123,
"AccountsDate": "2023-12-25",
"AccountsType": "<string>",
"Turnover": 123,
"EBIT": 123,
"NetIncome": 123,
"EmployeesHere": 123,
"EmployeesTotal": 123
}
],
"SimilarCompanies": [
{
"CompanyNumber": "<string>",
"SimilarityScore": 123
}
]
}
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
An API key issued by The Data City, sent as: Authorization: Bearer YOUR_KEY
Body
application/json
Request model for filtering French companies with comprehensive search criteria
Filter by NAF sections (broader business activity categories)
Filter by company name (partial match)
Maximum string length:
500Filter by country
Maximum string length:
100Filter by employee range (e.g., "1-9", "10-49", "50-249", "250+")
Maximum string length:
20Filter by legal form slug from GET /api/filters (legalForms[].id).
Maximum string length:
150Filter by one or more legal form slugs from GET /api/filters (legalForms[].id). Matches any listed form (OR).
Maximum array length:
100Filter by headquarters postal code
Maximum string length:
10Pattern:
^[0-9]{5}$Filter by commune (municipality) names. Matches companies where headquarters postcode details contain the specified commune names.
Maximum array length:
50Filter by date of incorporation (exact match)
Filter by date of incorporation (from date, inclusive)
Filter by date of incorporation (to date, inclusive)
Filter companies that have a website
Filter by operating location addresses (partial match)
Maximum array length:
20Filter by operating location postcodes
Maximum array length:
50Filter by operating location communes (municipality names). Matches companies where any operating location postcode details contain the specified commune names.
Maximum array length:
50Filter by operating location NAF codes
Minimum annual turnover in euros
Required range:
0 <= x <= 9223372036854776000Maximum annual turnover in euros
Required range:
0 <= x <= 9223372036854776000Minimum EBIT (Earnings Before Interest and Taxes) in euros
Required range:
-9223372036854776000 <= x <= 9223372036854776000Maximum EBIT (Earnings Before Interest and Taxes) in euros
Required range:
-9223372036854776000 <= x <= 9223372036854776000Minimum net income in euros
Required range:
-9223372036854776000 <= x <= 9223372036854776000Maximum net income in euros
Required range:
-9223372036854776000 <= x <= 9223372036854776000Filter by specific financial year ending
Minimum financial year ending
Maximum financial year ending
Filter by accounts type (e.g., "Bilan", "Simplified")
Maximum string length:
50Filter by RTIC codes. Matches companies that have any of the specified RTIC codes.
South edge of a geographic bounding box (minimum latitude), inclusive. WGS-84 decimal degrees.
Required range:
-90 <= x <= 90North edge of a geographic bounding box (maximum latitude), inclusive. WGS-84 decimal degrees.
Required range:
-90 <= x <= 90West edge of a geographic bounding box (minimum longitude), inclusive. WGS-84 decimal degrees.
Required range:
-180 <= x <= 180East edge of a geographic bounding box (maximum longitude), inclusive. WGS-84 decimal degrees.
Required range:
-180 <= x <= 180Restrict results to these Siren (company) numbers.
Maximum array length:
5000Exclude these Siren (company) numbers.
Maximum array length:
5000Filter by companies that have web text
When false, skips insight bucket aggregation. Omit or null for default (include insights).
When false, skips total-count queries and omits TotalCount from the response. Omit or null for default (include total count).
When true, nested location lists are loaded on each company. Omit or null for default (omit lists).
Maximum number of results to return (uses QueryConstants.MaxQueryLimit)
Required range:
1 <= x <= 1000Number of results to skip for pagination (default: 0)
Required range:
0 <= x <= 2147483647Sort options for the results
Maximum array length:
10Show child attributes
Show child attributes
Minimum raw classifier score (bias + weighted terms), not a percentage.
List of company numbers to include in the classification
List of company numbers to exclude from the classification
Optional RTIC vertical code whose training rows are loaded from the vertical seed parquet.
When true, adds translated web-text training rows for TDC_Global_Server_API_FR.Models.Filtering.ClassificationFilters.Yes and TDC_Global_Server_API_FR.Models.Filtering.ClassificationFilters.No companies. When omitted, uses the host default.
When true, vertical seed uses only the host native language, not English.
List of company numbers to manually include in the classification
List of company numbers to manually exclude from the classification
Response
OK
Complete classification API payload (host chooses for JSON shape, e.g. Siren vs company number).
Status and timing metrics for a classification operation.
Show child attributes
Show child attributes
Count of companies scoring strictly above the cutoff.
Count of those companies that also match active filters.
Classifier model identifier.
Trained classifier vocabulary weights (linear model coefficients).
Show child attributes
Show child attributes
Histogram of scores across the candidate set.
Show child attributes
Show child attributes
Per-company classification results.
Show child attributes
Show child attributes
Last modified on July 30, 2026
⌘I