Classify companies
curl --request POST \
--url https://global-api.thedatacity.com/v1/ie/classification \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"NACEs": [
"<string>"
],
"Name": "<string>",
"Country": "<string>",
"LegalForm": "<string>",
"LegalForms": [
"<string>"
],
"HQPostcode": "<string>",
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": true,
"OperatingLocationAddresses": [
"<string>"
],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": [
"<string>"
],
"RNACEs": [
"<string>"
],
"State": [
"<string>"
],
"Zipcode": [
"<string>"
],
"Town": [
"<string>"
],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"HasWebText": true,
"Includes": [
"<string>"
],
"Excludes": [
"<string>"
],
"WebTextPositiveKeywords": [
"<string>"
],
"WebTextPositiveKeywordsOperator": "<string>",
"WebTextPositiveKeywordsMode": "<string>",
"WebTextNegativeKeywords": [
"<string>"
],
"WebTextNegativeKeywordsOperator": "<string>",
"WebTextNegativeKeywordsMode": "<string>",
"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/ie/classification"
payload = {
"NACEs": ["<string>"],
"Name": "<string>",
"Country": "<string>",
"LegalForm": "<string>",
"LegalForms": ["<string>"],
"HQPostcode": "<string>",
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": True,
"OperatingLocationAddresses": ["<string>"],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": ["<string>"],
"RNACEs": ["<string>"],
"State": ["<string>"],
"Zipcode": ["<string>"],
"Town": ["<string>"],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"HasWebText": True,
"Includes": ["<string>"],
"Excludes": ["<string>"],
"WebTextPositiveKeywords": ["<string>"],
"WebTextPositiveKeywordsOperator": "<string>",
"WebTextPositiveKeywordsMode": "<string>",
"WebTextNegativeKeywords": ["<string>"],
"WebTextNegativeKeywordsOperator": "<string>",
"WebTextNegativeKeywordsMode": "<string>",
"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({
NACEs: ['<string>'],
Name: '<string>',
Country: '<string>',
LegalForm: '<string>',
LegalForms: ['<string>'],
HQPostcode: '<string>',
DateOfIncorporation: '2023-12-25',
IncorporationDateFrom: '2023-12-25',
IncorporationDateTo: '2023-12-25',
HasWebsite: true,
OperatingLocationAddresses: ['<string>'],
MinTurnover: 4611686018427388000,
MaxTurnover: 4611686018427388000,
MinEBIT: 0,
MaxEBIT: 0,
MinNetIncome: 0,
MaxNetIncome: 0,
FinancialYearEnding: 123,
MinFinancialYearEnding: 123,
MaxFinancialYearEnding: 123,
AccountsType: '<string>',
RTICs: ['<string>'],
RNACEs: ['<string>'],
State: ['<string>'],
Zipcode: ['<string>'],
Town: ['<string>'],
LowerLatitude: 0,
UpperLatitude: 0,
LowerLongitude: 0,
UpperLongitude: 0,
HasWebText: true,
Includes: ['<string>'],
Excludes: ['<string>'],
WebTextPositiveKeywords: ['<string>'],
WebTextPositiveKeywordsOperator: '<string>',
WebTextPositiveKeywordsMode: '<string>',
WebTextNegativeKeywords: ['<string>'],
WebTextNegativeKeywordsOperator: '<string>',
WebTextNegativeKeywordsMode: '<string>',
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/ie/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/ie/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([
'NACEs' => [
'<string>'
],
'Name' => '<string>',
'Country' => '<string>',
'LegalForm' => '<string>',
'LegalForms' => [
'<string>'
],
'HQPostcode' => '<string>',
'DateOfIncorporation' => '2023-12-25',
'IncorporationDateFrom' => '2023-12-25',
'IncorporationDateTo' => '2023-12-25',
'HasWebsite' => true,
'OperatingLocationAddresses' => [
'<string>'
],
'MinTurnover' => 4611686018427388000,
'MaxTurnover' => 4611686018427388000,
'MinEBIT' => 0,
'MaxEBIT' => 0,
'MinNetIncome' => 0,
'MaxNetIncome' => 0,
'FinancialYearEnding' => 123,
'MinFinancialYearEnding' => 123,
'MaxFinancialYearEnding' => 123,
'AccountsType' => '<string>',
'RTICs' => [
'<string>'
],
'RNACEs' => [
'<string>'
],
'State' => [
'<string>'
],
'Zipcode' => [
'<string>'
],
'Town' => [
'<string>'
],
'LowerLatitude' => 0,
'UpperLatitude' => 0,
'LowerLongitude' => 0,
'UpperLongitude' => 0,
'HasWebText' => true,
'Includes' => [
'<string>'
],
'Excludes' => [
'<string>'
],
'WebTextPositiveKeywords' => [
'<string>'
],
'WebTextPositiveKeywordsOperator' => '<string>',
'WebTextPositiveKeywordsMode' => '<string>',
'WebTextNegativeKeywords' => [
'<string>'
],
'WebTextNegativeKeywordsOperator' => '<string>',
'WebTextNegativeKeywordsMode' => '<string>',
'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/ie/classification"
payload := strings.NewReader("{\n \"NACEs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\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 \"RNACEs\": [\n \"<string>\"\n ],\n \"State\": [\n \"<string>\"\n ],\n \"Zipcode\": [\n \"<string>\"\n ],\n \"Town\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"HasWebText\": true,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywords\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywordsOperator\": \"<string>\",\n \"WebTextPositiveKeywordsMode\": \"<string>\",\n \"WebTextNegativeKeywords\": [\n \"<string>\"\n ],\n \"WebTextNegativeKeywordsOperator\": \"<string>\",\n \"WebTextNegativeKeywordsMode\": \"<string>\",\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/ie/classification")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"NACEs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\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 \"RNACEs\": [\n \"<string>\"\n ],\n \"State\": [\n \"<string>\"\n ],\n \"Zipcode\": [\n \"<string>\"\n ],\n \"Town\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"HasWebText\": true,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywords\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywordsOperator\": \"<string>\",\n \"WebTextPositiveKeywordsMode\": \"<string>\",\n \"WebTextNegativeKeywords\": [\n \"<string>\"\n ],\n \"WebTextNegativeKeywordsOperator\": \"<string>\",\n \"WebTextNegativeKeywordsMode\": \"<string>\",\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/ie/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 \"NACEs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\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 \"RNACEs\": [\n \"<string>\"\n ],\n \"State\": [\n \"<string>\"\n ],\n \"Zipcode\": [\n \"<string>\"\n ],\n \"Town\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"HasWebText\": true,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywords\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywordsOperator\": \"<string>\",\n \"WebTextPositiveKeywordsMode\": \"<string>\",\n \"WebTextNegativeKeywords\": [\n \"<string>\"\n ],\n \"WebTextNegativeKeywordsOperator\": \"<string>\",\n \"WebTextNegativeKeywordsMode\": \"<string>\",\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>",
"CompanyNumber": "<string>",
"Score": 123,
"Confidence": 123,
"WordsMatched": 123,
"CompanyURL": "<string>",
"WordScores": [
{
"Word": "<string>",
"Score": 123
}
],
"CompanyDetails": {
"CompanyNumber": "<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,
"Name": "<string>",
"Website": "<string>",
"Country": "<string>",
"HQAddress": "<string>",
"HQPostcode": "<string>",
"HQPostcodeDetails": {
"DepartmentName": "<string>",
"OrganisationName": "<string>",
"SubBuildingName": "<string>",
"BuildingName": "<string>",
"POBoxNumber": "<string>",
"BuildingNumber": "<string>",
"BuildingGroup": "<string>",
"DependentStreet": "<string>",
"MainStreet": "<string>",
"DoubleDependentLocality": "<string>",
"DependentLocality": "<string>",
"PostTown": "<string>",
"County": "<string>",
"Postcode": "<string>",
"Latitude": 123,
"Longitude": 123
},
"Address": "<string>",
"Town": "<string>",
"State": "<string>",
"Phone": "<string>",
"Zipcode": "<string>",
"Latitude": 123,
"Longitude": 123,
"Employees": 123,
"Turnover": 123,
"NACEs": [
"<string>"
],
"RNACEs": [
{
"CompanyNumber": "<string>",
"Code": "<string>",
"Name": "<string>",
"Score": 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
/
ie
/
classification
Classify companies
curl --request POST \
--url https://global-api.thedatacity.com/v1/ie/classification \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"NACEs": [
"<string>"
],
"Name": "<string>",
"Country": "<string>",
"LegalForm": "<string>",
"LegalForms": [
"<string>"
],
"HQPostcode": "<string>",
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": true,
"OperatingLocationAddresses": [
"<string>"
],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": [
"<string>"
],
"RNACEs": [
"<string>"
],
"State": [
"<string>"
],
"Zipcode": [
"<string>"
],
"Town": [
"<string>"
],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"HasWebText": true,
"Includes": [
"<string>"
],
"Excludes": [
"<string>"
],
"WebTextPositiveKeywords": [
"<string>"
],
"WebTextPositiveKeywordsOperator": "<string>",
"WebTextPositiveKeywordsMode": "<string>",
"WebTextNegativeKeywords": [
"<string>"
],
"WebTextNegativeKeywordsOperator": "<string>",
"WebTextNegativeKeywordsMode": "<string>",
"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/ie/classification"
payload = {
"NACEs": ["<string>"],
"Name": "<string>",
"Country": "<string>",
"LegalForm": "<string>",
"LegalForms": ["<string>"],
"HQPostcode": "<string>",
"DateOfIncorporation": "2023-12-25",
"IncorporationDateFrom": "2023-12-25",
"IncorporationDateTo": "2023-12-25",
"HasWebsite": True,
"OperatingLocationAddresses": ["<string>"],
"MinTurnover": 4611686018427388000,
"MaxTurnover": 4611686018427388000,
"MinEBIT": 0,
"MaxEBIT": 0,
"MinNetIncome": 0,
"MaxNetIncome": 0,
"FinancialYearEnding": 123,
"MinFinancialYearEnding": 123,
"MaxFinancialYearEnding": 123,
"AccountsType": "<string>",
"RTICs": ["<string>"],
"RNACEs": ["<string>"],
"State": ["<string>"],
"Zipcode": ["<string>"],
"Town": ["<string>"],
"LowerLatitude": 0,
"UpperLatitude": 0,
"LowerLongitude": 0,
"UpperLongitude": 0,
"HasWebText": True,
"Includes": ["<string>"],
"Excludes": ["<string>"],
"WebTextPositiveKeywords": ["<string>"],
"WebTextPositiveKeywordsOperator": "<string>",
"WebTextPositiveKeywordsMode": "<string>",
"WebTextNegativeKeywords": ["<string>"],
"WebTextNegativeKeywordsOperator": "<string>",
"WebTextNegativeKeywordsMode": "<string>",
"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({
NACEs: ['<string>'],
Name: '<string>',
Country: '<string>',
LegalForm: '<string>',
LegalForms: ['<string>'],
HQPostcode: '<string>',
DateOfIncorporation: '2023-12-25',
IncorporationDateFrom: '2023-12-25',
IncorporationDateTo: '2023-12-25',
HasWebsite: true,
OperatingLocationAddresses: ['<string>'],
MinTurnover: 4611686018427388000,
MaxTurnover: 4611686018427388000,
MinEBIT: 0,
MaxEBIT: 0,
MinNetIncome: 0,
MaxNetIncome: 0,
FinancialYearEnding: 123,
MinFinancialYearEnding: 123,
MaxFinancialYearEnding: 123,
AccountsType: '<string>',
RTICs: ['<string>'],
RNACEs: ['<string>'],
State: ['<string>'],
Zipcode: ['<string>'],
Town: ['<string>'],
LowerLatitude: 0,
UpperLatitude: 0,
LowerLongitude: 0,
UpperLongitude: 0,
HasWebText: true,
Includes: ['<string>'],
Excludes: ['<string>'],
WebTextPositiveKeywords: ['<string>'],
WebTextPositiveKeywordsOperator: '<string>',
WebTextPositiveKeywordsMode: '<string>',
WebTextNegativeKeywords: ['<string>'],
WebTextNegativeKeywordsOperator: '<string>',
WebTextNegativeKeywordsMode: '<string>',
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/ie/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/ie/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([
'NACEs' => [
'<string>'
],
'Name' => '<string>',
'Country' => '<string>',
'LegalForm' => '<string>',
'LegalForms' => [
'<string>'
],
'HQPostcode' => '<string>',
'DateOfIncorporation' => '2023-12-25',
'IncorporationDateFrom' => '2023-12-25',
'IncorporationDateTo' => '2023-12-25',
'HasWebsite' => true,
'OperatingLocationAddresses' => [
'<string>'
],
'MinTurnover' => 4611686018427388000,
'MaxTurnover' => 4611686018427388000,
'MinEBIT' => 0,
'MaxEBIT' => 0,
'MinNetIncome' => 0,
'MaxNetIncome' => 0,
'FinancialYearEnding' => 123,
'MinFinancialYearEnding' => 123,
'MaxFinancialYearEnding' => 123,
'AccountsType' => '<string>',
'RTICs' => [
'<string>'
],
'RNACEs' => [
'<string>'
],
'State' => [
'<string>'
],
'Zipcode' => [
'<string>'
],
'Town' => [
'<string>'
],
'LowerLatitude' => 0,
'UpperLatitude' => 0,
'LowerLongitude' => 0,
'UpperLongitude' => 0,
'HasWebText' => true,
'Includes' => [
'<string>'
],
'Excludes' => [
'<string>'
],
'WebTextPositiveKeywords' => [
'<string>'
],
'WebTextPositiveKeywordsOperator' => '<string>',
'WebTextPositiveKeywordsMode' => '<string>',
'WebTextNegativeKeywords' => [
'<string>'
],
'WebTextNegativeKeywordsOperator' => '<string>',
'WebTextNegativeKeywordsMode' => '<string>',
'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/ie/classification"
payload := strings.NewReader("{\n \"NACEs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\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 \"RNACEs\": [\n \"<string>\"\n ],\n \"State\": [\n \"<string>\"\n ],\n \"Zipcode\": [\n \"<string>\"\n ],\n \"Town\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"HasWebText\": true,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywords\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywordsOperator\": \"<string>\",\n \"WebTextPositiveKeywordsMode\": \"<string>\",\n \"WebTextNegativeKeywords\": [\n \"<string>\"\n ],\n \"WebTextNegativeKeywordsOperator\": \"<string>\",\n \"WebTextNegativeKeywordsMode\": \"<string>\",\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/ie/classification")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"NACEs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\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 \"RNACEs\": [\n \"<string>\"\n ],\n \"State\": [\n \"<string>\"\n ],\n \"Zipcode\": [\n \"<string>\"\n ],\n \"Town\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"HasWebText\": true,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywords\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywordsOperator\": \"<string>\",\n \"WebTextPositiveKeywordsMode\": \"<string>\",\n \"WebTextNegativeKeywords\": [\n \"<string>\"\n ],\n \"WebTextNegativeKeywordsOperator\": \"<string>\",\n \"WebTextNegativeKeywordsMode\": \"<string>\",\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/ie/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 \"NACEs\": [\n \"<string>\"\n ],\n \"Name\": \"<string>\",\n \"Country\": \"<string>\",\n \"LegalForm\": \"<string>\",\n \"LegalForms\": [\n \"<string>\"\n ],\n \"HQPostcode\": \"<string>\",\n \"DateOfIncorporation\": \"2023-12-25\",\n \"IncorporationDateFrom\": \"2023-12-25\",\n \"IncorporationDateTo\": \"2023-12-25\",\n \"HasWebsite\": true,\n \"OperatingLocationAddresses\": [\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 \"RNACEs\": [\n \"<string>\"\n ],\n \"State\": [\n \"<string>\"\n ],\n \"Zipcode\": [\n \"<string>\"\n ],\n \"Town\": [\n \"<string>\"\n ],\n \"LowerLatitude\": 0,\n \"UpperLatitude\": 0,\n \"LowerLongitude\": 0,\n \"UpperLongitude\": 0,\n \"HasWebText\": true,\n \"Includes\": [\n \"<string>\"\n ],\n \"Excludes\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywords\": [\n \"<string>\"\n ],\n \"WebTextPositiveKeywordsOperator\": \"<string>\",\n \"WebTextPositiveKeywordsMode\": \"<string>\",\n \"WebTextNegativeKeywords\": [\n \"<string>\"\n ],\n \"WebTextNegativeKeywordsOperator\": \"<string>\",\n \"WebTextNegativeKeywordsMode\": \"<string>\",\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>",
"CompanyNumber": "<string>",
"Score": 123,
"Confidence": 123,
"WordsMatched": 123,
"CompanyURL": "<string>",
"WordScores": [
{
"Word": "<string>",
"Score": 123
}
],
"CompanyDetails": {
"CompanyNumber": "<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,
"Name": "<string>",
"Website": "<string>",
"Country": "<string>",
"HQAddress": "<string>",
"HQPostcode": "<string>",
"HQPostcodeDetails": {
"DepartmentName": "<string>",
"OrganisationName": "<string>",
"SubBuildingName": "<string>",
"BuildingName": "<string>",
"POBoxNumber": "<string>",
"BuildingNumber": "<string>",
"BuildingGroup": "<string>",
"DependentStreet": "<string>",
"MainStreet": "<string>",
"DoubleDependentLocality": "<string>",
"DependentLocality": "<string>",
"PostTown": "<string>",
"County": "<string>",
"Postcode": "<string>",
"Latitude": 123,
"Longitude": 123
},
"Address": "<string>",
"Town": "<string>",
"State": "<string>",
"Phone": "<string>",
"Zipcode": "<string>",
"Latitude": 123,
"Longitude": 123,
"Employees": 123,
"Turnover": 123,
"NACEs": [
"<string>"
],
"RNACEs": [
{
"CompanyNumber": "<string>",
"Code": "<string>",
"Name": "<string>",
"Score": 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
Body
application/json
Request model for filtering companies with comprehensive search criteria
Response
OK
Complete classification API payload (host chooses for JSON shape, e.g. Siren vs company number).
Was this page helpful?