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>"
}

POST

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

Authorization

string

header

required

An API key issued by The Data City, sent as: Authorization: Bearer YOUR_KEY

Body

application/json

Request model for filtering companies with comprehensive search criteria

NACEs

string[] | null

Filter by primary industry scheme codes (wire name set at scaffold time).

Name

string | null

Filter by company name (partial match)

Maximum string length: 500

Country

string | null

Filter by country

Maximum string length: 100

LegalForm

string | null

Filter by legal form (e.g., "Corporation", "LLC", "Partnership", "Sole Proprietorship")

Maximum string length: 150

LegalForms

string[] | null

Filter by one or more legal forms from GET /api/filters (legalForms[].id). Matches any listed form (OR).

Maximum array length: 100

HQPostcode

string | null

Filter by headquarters postal code

Maximum string length: 10

Pattern: ^[0-9]{5}$

DateOfIncorporation

string<date> | null

Filter by date of incorporation (exact match)

IncorporationDateFrom

string<date> | null

Filter by minimum date of incorporation (inclusive)

IncorporationDateTo

string<date> | null

Filter by maximum date of incorporation (inclusive)

HasWebsite

boolean | null

Filter companies that have a website

OperatingLocationAddresses

string[] | null

Filter by operating location addresses (partial match)

Maximum array length: 20

MinTurnover

integer<int64> | null

Minimum annual turnover value

Required range: 0 <= x <= 9223372036854776000

MaxTurnover

integer<int64> | null

Maximum annual turnover value

Required range: 0 <= x <= 9223372036854776000

MinEBIT

integer<int64> | null

Minimum EBIT (Earnings Before Interest and Taxes) value

Required range: -9223372036854776000 <= x <= 9223372036854776000

MaxEBIT

integer<int64> | null

Maximum EBIT (Earnings Before Interest and Taxes) value

Required range: -9223372036854776000 <= x <= 9223372036854776000

MinNetIncome

integer<int64> | null

Minimum net income value

Required range: -9223372036854776000 <= x <= 9223372036854776000

MaxNetIncome

integer<int64> | null

Maximum net income value

Required range: -9223372036854776000 <= x <= 9223372036854776000

FinancialYearEnding

integer<int32> | null

Filter by specific financial year ending

MinFinancialYearEnding

integer<int32> | null

Minimum financial year ending

MaxFinancialYearEnding

integer<int32> | null

Maximum financial year ending

AccountsType

string | null

Filter by accounts type (e.g., "Full", "Abbreviated", "Small")

Maximum string length: 50

RTICs

string[] | null

Filter by RTIC codes. Matches companies that have any of the specified RTIC codes.

RNACEs

string[] | null

Filter by secondary industry scheme codes (wire name set at scaffold time).

State

string[] | null

Filter by state

Maximum array length: 100

Zipcode

string[] | null

Filter by zipcode

Maximum array length: 100

Town

string[] | null

Filter by town

Maximum array length: 1000

LowerLatitude

number<double> | null

South edge of a geographic bounding box (minimum latitude), inclusive. WGS-84 decimal degrees.

Required range: -90 <= x <= 90

UpperLatitude

number<double> | null

North edge of a geographic bounding box (maximum latitude), inclusive. WGS-84 decimal degrees.

Required range: -90 <= x <= 90

LowerLongitude

number<double> | null

West edge of a geographic bounding box (minimum longitude), inclusive. WGS-84 decimal degrees.

Required range: -180 <= x <= 180

UpperLongitude

number<double> | null

East edge of a geographic bounding box (maximum longitude), inclusive. WGS-84 decimal degrees.

Required range: -180 <= x <= 180

HasWebText

boolean | null

Filter by companies that have web text

Includes

string[] | null

Restrict results to these company numbers (CompanyNumber IN (...)).

Maximum array length: 5000

Excludes

string[] | null

Exclude these company numbers (CompanyNumber NOT IN (...)).

Maximum array length: 5000

WebTextPositiveKeywords

string[] | null

Positive keywords matched against web text (BM25 when FTS index exists; otherwise ILIKE).

Maximum array length: 25

WebTextPositiveKeywordsOperator

string | null

Combines positive keywords: AND (all) or OR (any).

Pattern: ^(AND|OR)$

WebTextPositiveKeywordsMode

string | null

deprecated

Backward-compatible alias for TDC_Global_Server_API_IE.Models.Filtering.Filters.WebTextPositiveKeywordsOperator.

Pattern: ^(AND|OR)$

WebTextNegativeKeywords

string[] | null

Negative keywords: rows matching these are excluded.

Maximum array length: 25

WebTextNegativeKeywordsOperator

string | null

Combines negative keyword checks inside NOT (...).

Pattern: ^(AND|OR)$

WebTextNegativeKeywordsMode

string | null

deprecated

Backward-compatible alias for TDC_Global_Server_API_IE.Models.Filtering.Filters.WebTextNegativeKeywordsOperator.

Pattern: ^(AND|OR)$

IncludeInsights

boolean | null

When false, skips insight bucket aggregation. Omit or null for default (include insights).

IncludeTotalCount

boolean | null

When false, skips total-count queries and omits TotalCount from the response. Omit or null for default (include total count).

IncludesLocations

boolean

When true, nested location lists are loaded on each company. Omit or null for default (omit lists).

Limit

integer<int32> | null

Maximum number of results to return (uses QueryConstants.MaxQueryLimit)

Required range: 1 <= x <= 1000

Offset

integer<int32> | null

Number of results to skip for pagination (default: 0)

Required range: 0 <= x <= 2147483647

SortBy

object[] | null

Sort options for the results

Maximum array length: 10

Show child attributes

Cutoff

number<double> | null

Minimum raw classifier score (bias + weighted terms), not a percentage.

Yes

string[] | null

List of company numbers to include in the classification

string[] | null

List of company numbers to exclude from the classification

VerticalSeed

string | null

Optional RTIC vertical code whose training rows are loaded from the vertical seed parquet.

UseTranslatedWebTextForYesNo

boolean | null

When true, adds translated web-text training rows for TDC_Global_Server_API_IE.Models.Filtering.ClassificationFilters.Yes and TDC_Global_Server_API_IE.Models.Filtering.ClassificationFilters.No companies. When omitted, uses the host default.

VerticalSeedNativeLanguageOnly

boolean

When true, vertical seed uses only the host native language, not English.

ManuallyInclude

string[] | null

List of company numbers to manually include in the classification

ManuallyExclude

string[] | null

List of company numbers to manually exclude from the classification

Response

Complete classification API payload (host chooses for JSON shape, e.g. Siren vs company number).

Status

object

Status and timing metrics for a classification operation.

Show child attributes

CompaniesAboveCutoff

integer<int64>

Count of companies scoring strictly above the cutoff.

CompaniesAboveCutoffMatchingFilters

integer<int64>

Count of those companies that also match active filters.

ModelCode

string | null

Classifier model identifier.

WordScores

object[] | null

Trained classifier vocabulary weights (linear model coefficients).

Show child attributes

ScoreDistribution

object[] | null

Histogram of scores across the candidate set.

Show child attributes

Results

object[] | null

Per-company classification results.

Show child attributes

Last modified on July 30, 2026

⌘I