### Example Billing Data Source: https://northdata.github.io/doc/api Illustrates the structure of the Billing response object, including the number of requests and the start and end dates of the billing period. ```json { "numberOfRequests" : 0, "periodStart" : "2000-01-23", "periodEnd" : "2000-01-23" } ``` -------------------------------- ### API Endpoint: Get Reference V1 Overview Source: https://northdata.github.io/doc/api This snippet shows the GET request for the /reference/v1/overview endpoint. It is used to retrieve meta information about the API. ```bash get /reference/v1/overview ``` -------------------------------- ### Person JSON Response Example Source: https://northdata.github.io/doc/api Example of a successful JSON response when retrieving person data. Includes details like birth information, name, and associated filings. ```json { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" } ``` -------------------------------- ### Example Company Data Source: https://northdata.github.io/doc/api This JSON object represents example data for a company, including its ID, subject, external sources, related companies, and financial sheets. ```json { "euId" : "euId", "subject" : "subject", "extras" : [ { "sourceUrl" : "sourceUrl", "sourceName" : "sourceName", "items" : [ { "formattedHtmlValue" : "formattedHtmlValue", "name" : "name", "id" : "id", "value" : "value" }, { "formattedHtmlValue" : "formattedHtmlValue", "name" : "name", "id" : "id", "value" : "value" } ] }, { "sourceUrl" : "sourceUrl", "sourceName" : "sourceName", "items" : [ { "formattedHtmlValue" : "formattedHtmlValue", "name" : "name", "id" : "id", "value" : "value" }, { "formattedHtmlValue" : "formattedHtmlValue", "name" : "name", "id" : "id", "value" : "value" } ] } ], "northDataUrl" : "northDataUrl", "lei" : "lei", "relatedCompanies" : { "items" : [ { "person" : { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" }, "roles" : [ { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" }, { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" } ], "description" : "description" }, { "person" : { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" }, "roles" : [ { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" }, { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" } ], "description" : "description" } ] }, "filings" : [ null, null ], "originalSubject" : "originalSubject", "sheets" : [ { "columnHeaders" : [ { "date" : "2000-01-23" }, { "date" : "2000-01-23" } ], "unit" : "unit", "consolidated" : true, "rows" : [ { "cells" : [ { "value" : 5.637376656633329 }, { "value" : 5.637376656633329 } ], "level" : 5, "name" : "name" }, { "cells" : [ { "value" : 5.637376656633329 }, { "value" : 5.637376656633329 } ], "level" : 5, "name" : "name" } ], "type" : "balance", "reporting" : "HGB" }, { "columnHeaders" : [ { "date" : "2000-01-23" }, { "date" : "2000-01-23" } ], "unit" : "unit", "consolidated" : true, "rows" : [ { "cells" : [ { "value" : 5.637376656633329 }, { "value" : 5.637376656633329 } ], "level" : 5, "name" : "name" }, { "cells" : [ { ``` -------------------------------- ### Example JSON Data Structure Source: https://northdata.github.io/doc/api This is an example of the JSON data structure returned by the North Data API. It includes details about publications, companies, and their associated filings. ```json { "newPos" : "newPos", "publications" : [ { "date" : "2000-01-23", "internal" : { }, "attachments" : [ { "name" : "name", "contentType" : "contentType", "url" : "url" }, { "name" : "name", "contentType" : "contentType", "url" : "url" } ], "creationTime" : "2000-01-23T04:56:07.000+00:00", "language" : "language", "source" : "source", "originalLanguage" : "originalLanguage", "title" : "title", "mentionedCompanies" : { "items" : [ { "person" : { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" }, "roles" : [ { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" }, { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" } ], "description" : "description" }, { "person" : { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" }, "roles" : [ { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" }, { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" } ], "description" : "description" } ] }, "northDataUrl" : "northDataUrl", "structure" : { "topics" : [ { "name" : "name", "type" : "type", "value" : "value" }, { "name" : "name", "type" : "type", "value" : "value" } ] }, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "blocked" : true, "publisher" : { "euId" : "euId", "subject" : "subject", "extras" : [ { "sourceUrl" : "sourceUrl", "sourceName" : "sourceName", "items" : [ { "formattedHtmlValue" : "formattedHtmlValue", "name" : "name", "id" : "id", "value" : "value" }, { "formattedHtmlValue" : "formattedHtmlValue", "name" : "name", "id" : "id", "value" : "value" } ] } ] } } ] } ``` -------------------------------- ### API Overview Response (JSON) Source: https://northdata.github.io/doc/api Example JSON response for the /reference/v1/overview endpoint, detailing API metadata like legal form families, sources, topic types, and more. ```json { "legalFormFamilies" : [ "legalFormFamilies", "legalFormFamilies" ], "sources" : [ "sources", "sources" ], "topicTypes" : [ "topicTypes", "topicTypes" ], "segmentCodeStandards" : [ "segmentCodeStandards", "segmentCodeStandards" ], "registers" : [ { "country" : "country", "name" : "name", "sample" : "sample" }, { "country" : "country", "name" : "name", "sample" : "sample" } ], "countries" : "", "eventTypes" : [ { "id" : "id", "countries" : [ "countries", "countries" ] }, { "id" : "id", "countries" : [ "countries", "countries" ] } ], "legalForms" : [ { "id" : "id", "countries" : [ "countries", "countries" ] }, { "id" : "id", "countries" : [ "countries", "countries" ] } ], "roleTypes" : [ "roleTypes", "roleTypes" ], "legalStatuses" : [ "legalStatuses", "legalStatuses" ], "performanceIndicators" : [ { "id" : "id" }, { "id" : "id" } ] } ``` -------------------------------- ### Segment Codes List Response (JSON) Source: https://northdata.github.io/doc/api Example JSON response for the /reference/v1/segmentCodes endpoint, returning a list of segment codes for a specified standard. ```json [ "62.01", "62.01" ] ``` -------------------------------- ### GET /reference/v1/overview Source: https://northdata.github.io/doc/api Retrieves meta-information about the API, including supported parameter values for power search. This endpoint is useful for understanding the available data categories and their configurations. ```APIDOC ## GET /reference/v1/overview ### Description Returns meta information about the API, such as supported parameter values for power search. ### Method GET ### Endpoint /reference/v1/overview ### Return type OverviewResponse ### Response Example ```json { "legalFormFamilies" : [ "legalFormFamilies", "legalFormFamilies" ], "sources" : [ "sources", "sources" ], "topicTypes" : [ "topicTypes", "topicTypes" ], "segmentCodeStandards" : [ "segmentCodeStandards", "segmentCodeStandards" ], "registers" : [ { "country" : "country", "name" : "name", "sample" : "sample" }, { "country" : "country", "name" : "name", "sample" : "sample" } ], "countries" : "", "eventTypes" : [ { "id" : "id", "countries" : [ "countries", "countries" ] }, { "id" : "id", "countries" : [ "countries", "countries" ] } ], "legalForms" : [ { "id" : "id", "countries" : [ "countries", "countries" ] }, { "id" : "id", "countries" : [ "countries", "countries" ] } ], "roleTypes" : [ "roleTypes", "roleTypes" ], "legalStatuses" : [ "legalStatuses", "legalStatuses" ], "performanceIndicators" : [ { "id" : "id" }, { "id" : "id" } ] } ``` ``` -------------------------------- ### API Endpoint: Get Reference V1 Segment Codes Source: https://northdata.github.io/doc/api This snippet shows the GET request for the /reference/v1/segmentCodes endpoint. It is used to retrieve a list of segment codes for a given standard. ```bash get /reference/v1/segmentCodes ``` -------------------------------- ### Example JSON Data Structure Source: https://northdata.github.io/doc/api This is a sample JSON response from the North Data API. It illustrates the typical structure for retrieving information about a person and their associated publications and companies. ```json { "total" : 1, "offset" : 0, "nextPos" : "nextPos", "nextOffset" : 6, "results" : [ { "person" : { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" }, "publication" : { "date" : "2000-01-23", "internal" : { }, "attachments" : [ { "name" : "name", "contentType" : "contentType", "url" : "url" }, { "name" : "name", "contentType" : "contentType", "url" : "url" } ], "creationTime" : "2000-01-23T04:56:07.000+00:00", "language" : "language", "source" : "source", "originalLanguage" : "originalLanguage", "title" : "title", "mentionedCompanies" : { "items" : [ { "person" : { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" }, "roles" : [ { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" }, { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" } ], "description" : "description" }, { "person" : { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" }, "roles" : [ { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" }, { "date" : "2000-01-23", "sharesNominal" : { "unit" : "unit", "value" : 3.616076749251911 }, "name" : "name", "demotion" : true, "sharesPercent" : 9.301444243932576, "detail" : "detail", "type" : "type", "dir" : "None", "announce" : true, "group" : "Succession" } ], "description" : "description" } ] } } } ] } ``` -------------------------------- ### API Endpoint: Power Search V1 Source: https://northdata.github.io/doc/api This snippet shows the GET request for the /search/v1/power endpoint. This endpoint supports geo and financial criteria for power searches. ```bash get /search/v1/power ``` -------------------------------- ### Get Billing Requests Source: https://northdata.github.io/doc/api Retrieves the number of unique requests for a specified billing period. Supports filtering by year and month, and specifies the output format. ```http get /billing/v1/requests ``` -------------------------------- ### get /billing/v1/requests Source: https://northdata.github.io/doc/api Retrieves the number of unique requests for a specified billing period. Supports filtering by year and month, and allows specifying the output format. ```APIDOC ## GET /billing/v1/requests ### Description Retrieves the number of unique requests for a specified billing period. Supports filtering by year and month, and allows specifying the output format. ### Method GET ### Endpoint /_api/billing/v1/requests ### Parameters #### Query Parameters - **year** (int32) - Optional - Year of the billing period (>= 2024) - **month** (int32) - Optional - Month of the billing period (between 1 and 12) - **output** (string) - Optional - Response format (default: json) ### Response #### Success Response (200) A successful response returns a Billing object. ### Response Example ```json { "numberOfRequests" : 0, "periodStart" : "2000-01-23", "periodEnd" : "2000-01-23" } ``` ### Produces - application/json - application/xml ``` -------------------------------- ### get /search/v1/suggest Source: https://northdata.github.io/doc/api Provides quick company and person suggestions based on an input query. It supports filtering by domain, history, censor, offset, limit, output format, countries, and status. ```APIDOC ## GET /search/v1/suggest ### Description Provides quick company and person suggestions for a given input query. This endpoint is useful for auto-completing search fields. ### Method GET ### Endpoint /search/v1/suggest ### Query Parameters - **query** (string) - Required - The query string to search for. - **domain** (string) - Optional - "company" to match companies only, "person" to match persons only, empty to match all. - **history** (boolean) - Optional - Set to true to include former company names. - **censor** (boolean) - Optional - Should be set to true when presenting the content on a public website. - **offset** (int32) - Optional - Offset of the first item to return. - **limit** (int32) - Optional - Maximum number of items to return. - **output** (string) - Optional - Response format. Default is "json". - **countries** (array of strings) - Optional - List of country ISO codes to restrict the result set. An empty list retrieves all countries. Valid values can be retrieved dynamically from the `/reference/v1/overview` endpoint. - **status** (array of strings) - Optional - List of valid statuses (active, terminated, liquidation). Valid values can be retrieved dynamically from the `/reference/v1/overview` endpoint. ### Responses #### Success Response (200) - **SearchResults** (object) - A successful response containing search results. ``` -------------------------------- ### Search API Endpoint Source: https://northdata.github.io/doc/api This snippet shows the GET request for the search suggest endpoint. It is used for auto-completion to provide quick company and person suggestions based on an input query. ```HTTP get /search/v1/suggest ``` -------------------------------- ### get /company/v1/publications Source: https://northdata.github.io/doc/api Retrieve the publications associated with a company. Supports filtering by name, address, registration details, dates, and more. ```APIDOC ## GET /company/v1/publications ### Description Retrieve the publications associated with a company. Supports filtering by name, address, registration details, dates, and more. ### Method GET ### Endpoint /company/v1/publications ### Parameters #### Query Parameters - **name** (string) - Optional - company name - **address** (string) - Optional - company address (you only need to specify the city) - **registerId** (string) - Optional - the ID of under which the company is registered, for example HRB 12345 - **registerCity** (string) - Optional - the city of the court where the company is registered, for example Hamburg - **companyId** (string) - Optional - internal company id (do not store this id in an external database, it may change over time) - **fuzzyMatch** (boolean) - Optional - true to find best match (similar name and nearby address) - **registerKey** (string) - Optional - key that has been provided via the register uniqueKey field - **minTimestamp** (date-time) - Optional - minimum datetime publication was added to the database - **maxTimestamp** (date-time) - Optional - maximum datetime publication was added to the database - **minPublicationDate** (date) - Optional - minimum date publication was published on (by the source) - **maxPublicationDate** (date) - Optional - maximum date publication was published on (by the source) - **sources** (string) - Optional - DEPRECATED (will be removed at some point of time) - **source** (string) - Required - only publications with this source will be returned - **content** (boolean) - Optional - whether to include publication text / html (may significantly slow down response) - **attachments** (boolean) - Optional - whether to include publication attachments (binary, such as images or PDF) - **censor** (boolean) - Optional - should be set when presenting the content on a public website - **offset** (int32) - Optional - offset of first item to return - **limit** (int32) - Optional - maximum number of items to return - **output** (string) - Optional - response format default: json ### Responses #### Success Response (200) - **Company** (object) - A successful response Company - **GenericResponse** (object) - Return type ``` -------------------------------- ### GET /reference/v1/segmentCodes Source: https://northdata.github.io/doc/api Retrieves a list of segment codes for a specified standard. This is useful for filtering search results based on industry or business segments. ```APIDOC ## GET /reference/v1/segmentCodes ### Description Returns the list of segment codes for the requested standard. The `standard` parameter must be one of the segment code standards available in the `/reference/v1/overview` endpoint (`segmentCodeStandards`). ### Method GET ### Endpoint /reference/v1/segmentCodes ### Parameters #### Query Parameters - **standard** (string) - Required - Segment code standard name, as returned in the `segmentCodeStandards` property of `/reference/v1/overview`. ### Return type array[String] ### Response Example ```json [ "62.01", "62.01" ] ``` ``` -------------------------------- ### GET /search/v1/power Source: https://northdata.github.io/doc/api Performs a power search with support for geographical and financial criteria. This endpoint allows for complex queries to find specific business entities. ```APIDOC ## GET /search/v1/power ### Description Power search: supports geo and financial criteria ### Method GET ### Endpoint /search/v1/power ``` -------------------------------- ### get /pub/v1/publications Source: https://northdata.github.io/doc/api Retrieve publications. At most 10 publications are returned with each call. For more, repeat the call setting the pos parameter to the newPos attribute value of the response. ```APIDOC ## GET /pub/v1/publications ### Description Retrieve publications. At most 10 publications are returned with each call. For more, repeat the call setting the pos parameter to the newPos attribute value of the response. ### Method GET ### Endpoint /pub/v1/publications ### Parameters #### Query Parameters - **id** (optional) - publication id to get a single publication - **minDate** (optional) - DEPRECATED - please use minTimestamp or minPublicationDate instead format: date - **maxDate** (optional) - DEPRECATED - please use maxTimestamp or maxPublicationDate instead format: date - **minTimestamp** (optional) - minimum datetime publication was added to the database format: date-time - **maxTimestamp** (optional) - maximum datetime publication was added to the database format: date-time - **minPublicationDate** (optional) - minimum date publication was published on (by the source) format: date - **maxPublicationDate** (optional) - maximum date publication was published on (by the source) format: date - **sources** (optional) - DEPRECATED (will be removed at some point of time) - **source** (required) - only publications with this source will be returned - **content** (optional) - whether to include publication text / html (may significantly slow down response) - **attachments** (optional) - whether to include publication attachments (binary, such as images or PDF) - **publisherHistory** (optional) - true to include historical data for the publisher - **publisherFinancials** (optional) - true to include financial data for the publisher - **publisherRelations** (optional) - true to include related company and person data for the publisher - **publisherEvents** (optional) - true to include event data for the publisher - **publisherExtras** (optional) - true to include extra publisher data provided by 3rd parties - **publisherSheets** (optional) - true to include publisher sheets (balance, earnings) - **pos** (optional) - if additional results shall be downloaded, set this to the value of the newPos attribute of the previous response - **censor** (optional) - should be set when presenting the content on a public website - **output** (optional) - response format default: json ### Produces - `application/json` - `application/xml` ### Response #### Success Response (200) GenericResponse #### Response Example { "example": "response body" } ``` -------------------------------- ### get /person/v1/person Source: https://northdata.github.io/doc/api Retrieve a person's information. This endpoint allows fetching details about a person using various optional query parameters like first name, last name, address, birth date, person ID, and history flags. ```APIDOC ## GET /person/v1/person ### Description Retrieve a person's information. This endpoint allows fetching details about a person using various optional query parameters like first name, last name, address, birth date, person ID, and history flags. ### Method GET ### Endpoint /person/v1/person ### Query Parameters - **firstName** (string) - Optional - first name(s) of a person - **lastName** (string) - Optional - last name of a person - **address** (string) - Optional - person address (you only need to specify the city) - **birthDate** (date) - Optional - birth date format: date - **personId** (string) - Optional - internal person id (do not store this id in an external database, it may change over time) - **history** (boolean) - Optional - true to include historical data - **relations** (boolean) - Optional - true to include related company and person data. Note: For owners, only majority shareholders are included. For more owners, use the "owners" parameter instead. - **alwaysResolve** (boolean) - Optional - true to lookup current state of related company from database - **output** (string) - Optional - response format default: json ### Response #### Success Response (200) - **birthMonth** (integer) - **filings** (array) - **deceased** (boolean) - **blocked** (boolean) - **birthYear** (integer) - **name** (object) - **id** (string) - **birthDate** (string) - **northDataUrl** (string) - **lastUpdateTime** (string) ### Request Example ```json { "birthMonth" : 7, "filings" : [ { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" }, { "city" : "city", "name" : "name", "source" : "source", "id" : "id", "type" : "type" } ], "deceased" : true, "blocked" : true, "birthYear" : 2, "name" : { "firstName" : "firstName", "lastName" : "lastName", "title" : "title" }, "id" : "id", "birthDate" : "2000-01-23", "northDataUrl" : "northDataUrl", "lastUpdateTime" : "2000-01-23T04:56:07.000+00:00" } ``` ``` -------------------------------- ### get /search/v1/universal Source: https://northdata.github.io/doc/api Performs a universal search to find the best company and person matches for a given input query. It can filter results by domain, country, status, and include various data types such as historical data, financials, events, and related entities. ```APIDOC ## GET /search/v1/universal ### Description Provides best company and person matches for a given input query. This endpoint allows for detailed filtering and inclusion of various data types. ### Method GET ### Endpoint /search/v1/universal ### Parameters #### Query Parameters - **query** (string) - Required - The query string to search for. - **domain** (string) - Optional - Set to "company" for companies only, "person" for persons only, otherwise leave empty. - **pos** (string) - Optional - If additional results shall be downloaded, set this to the value of the nextPos attribute of the previous response. - **censor** (boolean) - Optional - Should be set when presenting the content on a public website. - **offset** (int32) - Optional - Offset of the first item to return. - **limit** (int32) - Optional - Maximum number of items to return. - **output** (string) - Optional - Response format. Default: json. - **countries** (array) - Optional - List of country ISO codes to restrict the result set (empty to retrieve all countries). Valid values can be retrieved dynamically from the `/reference/v1/overview` endpoint. - **status** (array) - Optional - List of valid statuses (active, terminated, liquidation). Valid values can be retrieved dynamically from the `/reference/v1/overview` endpoint. - **history** (boolean) - Optional - True to include historical data. - **financials** (boolean) - Optional - True to include financial data. - **events** (boolean) - Optional - True to include event data. - **eventType** (string) - Optional - Restrict which event types will be returned if events equals true. - **maxEvents** (int32) - Optional - Maximum number of events to return. - **relations** (boolean) - Optional - True to include related company and person data. Note: For owners, only majority shareholders are included. For more owners, use the "owners" parameter instead. - **owners** (boolean) - Optional - True to include all owners/shareholders (companies & persons) of the subject company. - **ownerships** (boolean) - Optional - True to include companies owned by the subject company. - **representatives** (boolean) - Optional - True to include legal representatives of the subject company (e.g., managing directors, board members). - **alwaysResolve** (boolean) - Optional - True to lookup current state of related company from database. - **sheets** (boolean) - Optional - True to include company financial sheets (balance, earnings). - **extras** (boolean) - Optional - True to include extra company data provided by 3rd parties. ### Produces - `application/json` - `application/xml` ### Responses #### Success Response (200) - **SearchResults** (object) - A successful response containing search results. ``` -------------------------------- ### Get Company Information Source: https://northdata.github.io/doc/api Retrieves detailed information about a company. Supports filtering by name, address, registration details, and includes options to retrieve historical data, financial data, events, related entities, and ownership structures. ```http get /company/v1/company ``` -------------------------------- ### get /company/v1/company Source: https://northdata.github.io/doc/api Retrieves detailed information about a specific company. Supports filtering by name, address, registration details, and includes options to fetch related data like financials, events, and ownership. ```APIDOC ## GET /company/v1/company ### Description Retrieves detailed information about a specific company. Supports filtering by name, address, registration details, and includes options to fetch related data like financials, events, and ownership. ### Method GET ### Endpoint /_api/company/v1/company ### Parameters #### Query Parameters - **name** (string) - Optional - Company name - **address** (string) - Optional - Company address (city only) - **registerId** (string) - Optional - Registration ID (e.g., HRB 12345) - **registerCity** (string) - Optional - City of the registration court - **companyId** (string) - Optional - Internal company ID (may change) - **fuzzyMatch** (boolean) - Optional - True to find the best match (similar name and nearby address) - **registerKey** (string) - Optional - Key provided via the register uniqueKey field - **history** (boolean) - Optional - True to include historical data - **financials** (boolean) - Optional - True to include financial data - **events** (boolean) - Optional - True to include event data - **eventType** (string) - Optional - Restrict event types to return if events is true - **maxEvents** (int32) - Optional - Maximum number of events to return - **relations** (boolean) - Optional - True to include related company and person data (only majority shareholders included by default) - **owners** (boolean) - Optional - True to include all owners/shareholders (companies & persons) - **ownerships** (boolean) - Optional - True to include companies owned by the subject company - **representatives** (boolean) - Optional - True to include legal representatives - **alwaysResolve** (boolean) - Optional - True to lookup current state of related company from database - **sheets** (boolean) - Optional - True to include company financial sheets - **extras** (boolean) - Optional - True to include extra company data provided by 3rd parties - **output** (string) - Optional - Response format (default: json) ### Return type Company ```