North Data API

Programmatic access to the North Data DB.
More information:
Contact Info: support@northdata.de
Version: 1.112.0
BasePath:/_api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
get /company/v1/company
(companyV1CompanyGet)
Retrieve a company.

Query parameters

name (optional)
Query Parameter — company name
address (optional)
Query Parameter — company address (you only need to specify the city)
registerId (optional)
Query Parameter — the ID of under which the company is registered, for example HRB 12345
registerCity (optional)
Query Parameter — the city of the court where the company is registered, for example Hamburg
companyId (optional)
Query Parameter — internal company id (do not store this id in an external database, it may change over time)
fuzzyMatch (optional)
Query Parameter — true to find best match (similar name and nearby address)
history (optional)
Query Parameter — true to include historical data
financials (optional)
Query Parameter — true to include financial data
events (optional)
Query Parameter — true to include event data
eventTypes (optional)
Query Parameter — restrict which event types wille be returned if events equals true
maxEvents (optional)
Query Parameter — maximum number of events to return format: int32
relations (optional)
Query Parameter — true to include related company and person data
output (optional)
Query Parameter — response format default: json

Return type

Company

Example data

Content-Type: application/json
{
  "relatedPersons" : "",
  "financials" : "",
  "address" : {
    "country" : "aeiou",
    "lng" : 6.027456183070403,
    "city" : "aeiou",
    "street" : "aeiou",
    "postalCode" : "aeiou",
    "lat" : 0.8008281904610115
  },
  "subject" : "aeiou",
  "extras" : [ {
    "sourceUrl" : "aeiou",
    "sourceName" : "aeiou",
    "items" : [ {
      "formattedHtmlValue" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou",
      "value" : "aeiou"
    } ]
  } ],
  "history" : {
    "financials" : [ {
      "date" : "2000-01-23",
      "note" : {
        "html" : "aeiou",
        "text" : "aeiou"
      },
      "consolidated" : true,
      "formattedDate" : "aeiou",
      "source" : {
        "snippets" : [ {
          "title" : "aeiou",
          "contentType" : "aeiou",
          "content" : "aeiou"
        } ],
        "publicationId" : "aeiou",
        "publicationTitle" : "aeiou",
        "publicationDate" : "2000-01-23",
        "auditorName" : "aeiou"
      },
      "items" : [ {
        "note" : "aeiou",
        "unit" : "aeiou",
        "name" : "aeiou",
        "formattedValue" : "aeiou",
        "id" : "aeiou",
        "value" : 1.4658129805029452
      } ]
    } ],
    "addresses" : [ {
      "date" : "2000-01-23",
      "address" : ""
    } ],
    "names" : [ {
      "date" : "2000-01-23",
      "name" : ""
    } ],
    "registers" : [ {
      "date" : "2000-01-23",
      "register" : ""
    } ]
  },
  "relatedCompanies" : {
    "items" : [ {
      "person" : {
        "relatedCompanies" : "",
        "address" : "",
        "deceased" : true,
        "birthYear" : 5,
        "name" : {
          "firstName" : "aeiou",
          "lastName" : "aeiou",
          "title" : "aeiou"
        },
        "id" : "aeiou",
        "birthDate" : "2000-01-23"
      },
      "roles" : [ {
        "date" : "2000-01-23",
        "name" : "aeiou",
        "demotion" : true,
        "type" : "Publisher",
        "dir" : "None",
        "announce" : true,
        "group" : "Succession"
      } ],
      "company" : ""
    } ]
  },
  "name" : {
    "name" : "aeiou",
    "legalForm" : "aeiou"
  },
  "id" : "aeiou",
  "terminated" : true,
  "events" : {
    "items" : [ {
      "date" : "2000-01-23",
      "description" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "register" : {
    "city" : "aeiou",
    "uniqueKey" : "aeiou",
    "id" : "aeiou"
  },
  "status" : "active"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response Company

Up
get /company/v1/publications
(companyV1PublicationsGet)
Retrieve the publications associated with a company.

Query parameters

name (optional)
Query Parameter — company name
address (optional)
Query Parameter — company address (you only need to specify the city)
registerId (optional)
Query Parameter — the ID of under which the company is registered, for example HRB 12345
registerCity (optional)
Query Parameter — the city of the court where the company is registered, for example Hamburg
companyId (optional)
Query Parameter — internal company id (do not store this id in an external database, it may change over time)
sources (optional)
Query Parameter — restrict which sources are allowed for the returned publications
content (optional)
Query Parameter — whether to include publication text / html (significantly slows down response)
censor (optional)
Query Parameter — should be set when presenting the content on a public website
offset (optional)
Query Parameter — offset of first item to return format: int32
limit (optional)
Query Parameter — maximum number of items to return format: int32
output (optional)
Query Parameter — response format default: json

Return type

GenericResponse

Example data

Content-Type: application/json
{
  "newPos" : "aeiou",
  "publications" : [ {
    "date" : "2000-01-23",
    "internal" : "{}",
    "source" : { },
    "title" : "aeiou",
    "mentionedCompanies" : "",
    "structure" : {
      "topics" : [ {
        "name" : "aeiou",
        "type" : "Entry",
        "value" : "aeiou"
      } ]
    },
    "filings" : [ {
      "city" : "aeiou",
      "id" : "aeiou"
    } ],
    "publisher" : {
      "relatedPersons" : "",
      "financials" : "",
      "address" : {
        "country" : "aeiou",
        "lng" : 6.027456183070403,
        "city" : "aeiou",
        "street" : "aeiou",
        "postalCode" : "aeiou",
        "lat" : 0.8008281904610115
      },
      "subject" : "aeiou",
      "extras" : [ {
        "sourceUrl" : "aeiou",
        "sourceName" : "aeiou",
        "items" : [ {
          "formattedHtmlValue" : "aeiou",
          "name" : "aeiou",
          "id" : "aeiou",
          "value" : "aeiou"
        } ]
      } ],
      "history" : {
        "financials" : [ {
          "date" : "2000-01-23",
          "note" : {
            "html" : "aeiou",
            "text" : "aeiou"
          },
          "consolidated" : true,
          "formattedDate" : "aeiou",
          "source" : {
            "snippets" : [ {
              "title" : "aeiou",
              "contentType" : "aeiou",
              "content" : "aeiou"
            } ],
            "publicationId" : "aeiou",
            "publicationTitle" : "aeiou",
            "publicationDate" : "2000-01-23",
            "auditorName" : "aeiou"
          },
          "items" : [ {
            "note" : "aeiou",
            "unit" : "aeiou",
            "name" : "aeiou",
            "formattedValue" : "aeiou",
            "id" : "aeiou",
            "value" : 1.4658129805029452
          } ]
        } ],
        "addresses" : [ {
          "date" : "2000-01-23",
          "address" : ""
        } ],
        "names" : [ {
          "date" : "2000-01-23",
          "name" : ""
        } ],
        "registers" : [ {
          "date" : "2000-01-23",
          "register" : ""
        } ]
      },
      "relatedCompanies" : {
        "items" : [ {
          "person" : {
            "relatedCompanies" : "",
            "address" : "",
            "deceased" : true,
            "birthYear" : 5,
            "name" : {
              "firstName" : "aeiou",
              "lastName" : "aeiou",
              "title" : "aeiou"
            },
            "id" : "aeiou",
            "birthDate" : "2000-01-23"
          },
          "roles" : [ {
            "date" : "2000-01-23",
            "name" : "aeiou",
            "demotion" : true,
            "type" : "Publisher",
            "dir" : "None",
            "announce" : true,
            "group" : "Succession"
          } ],
          "company" : ""
        } ]
      },
      "name" : {
        "name" : "aeiou",
        "legalForm" : "aeiou"
      },
      "id" : "aeiou",
      "terminated" : true,
      "events" : {
        "items" : [ {
          "date" : "2000-01-23",
          "description" : "aeiou",
          "type" : "aeiou"
        } ]
      },
      "register" : {
        "city" : "aeiou",
        "uniqueKey" : "aeiou",
        "id" : "aeiou"
      },
      "status" : "active"
    },
    "html" : "aeiou",
    "id" : "aeiou",
    "sourceName" : "aeiou",
    "text" : "aeiou",
    "category" : "aeiou",
    "mentionedPersons" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response GenericResponse

Up
get /person/v1/person
(personV1PersonGet)
Retrieve a person.

Query parameters

firstName (optional)
Query Parameter — first name(s) of a person
lastName (optional)
Query Parameter — last name of a person
address (optional)
Query Parameter — person address (you only need to specify the city)
birthDate (optional)
Query Parameter — birth date format: date
personId (optional)
Query Parameter — internal person id (do not store this id in an external database, it may change over time)
history (optional)
Query Parameter — true to include historical data
relations (optional)
Query Parameter — true to include related company data
output (optional)
Query Parameter — response format default: json

Return type

Person

Example data

Content-Type: application/json
{
  "relatedCompanies" : {
    "items" : [ {
      "person" : "",
      "roles" : [ {
        "date" : "2000-01-23",
        "name" : "aeiou",
        "demotion" : true,
        "type" : "Publisher",
        "dir" : "None",
        "announce" : true,
        "group" : "Succession"
      } ],
      "company" : {
        "relatedPersons" : "",
        "financials" : "",
        "address" : "",
        "subject" : "aeiou",
        "extras" : [ {
          "sourceUrl" : "aeiou",
          "sourceName" : "aeiou",
          "items" : [ {
            "formattedHtmlValue" : "aeiou",
            "name" : "aeiou",
            "id" : "aeiou",
            "value" : "aeiou"
          } ]
        } ],
        "history" : {
          "financials" : [ {
            "date" : "2000-01-23",
            "note" : {
              "html" : "aeiou",
              "text" : "aeiou"
            },
            "consolidated" : true,
            "formattedDate" : "aeiou",
            "source" : {
              "snippets" : [ {
                "title" : "aeiou",
                "contentType" : "aeiou",
                "content" : "aeiou"
              } ],
              "publicationId" : "aeiou",
              "publicationTitle" : "aeiou",
              "publicationDate" : "2000-01-23",
              "auditorName" : "aeiou"
            },
            "items" : [ {
              "note" : "aeiou",
              "unit" : "aeiou",
              "name" : "aeiou",
              "formattedValue" : "aeiou",
              "id" : "aeiou",
              "value" : 5.962133916683182
            } ]
          } ],
          "addresses" : [ {
            "date" : "2000-01-23",
            "address" : ""
          } ],
          "names" : [ {
            "date" : "2000-01-23",
            "name" : ""
          } ],
          "registers" : [ {
            "date" : "2000-01-23",
            "register" : ""
          } ]
        },
        "relatedCompanies" : "",
        "name" : {
          "name" : "aeiou",
          "legalForm" : "aeiou"
        },
        "id" : "aeiou",
        "terminated" : true,
        "events" : {
          "items" : [ {
            "date" : "2000-01-23",
            "description" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "register" : {
          "city" : "aeiou",
          "uniqueKey" : "aeiou",
          "id" : "aeiou"
        },
        "status" : "active"
      }
    } ]
  },
  "address" : {
    "country" : "aeiou",
    "lng" : 6.027456183070403,
    "city" : "aeiou",
    "street" : "aeiou",
    "postalCode" : "aeiou",
    "lat" : 0.8008281904610115
  },
  "deceased" : true,
  "birthYear" : 1,
  "name" : {
    "firstName" : "aeiou",
    "lastName" : "aeiou",
    "title" : "aeiou"
  },
  "id" : "aeiou",
  "birthDate" : "2000-01-23"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response Person

Up
get /person/v1/publications
(personV1PublicationsGet)
Retrieve the publications associated with a person.

Query parameters

firstName (optional)
Query Parameter — first name(s) of a person
lastName (optional)
Query Parameter — last name of a person
address (optional)
Query Parameter — person address (you only need to specify the city)
birthDate (optional)
Query Parameter — birth date format: date
personId (optional)
Query Parameter — internal person id (do not store this id in an external database, it may change over time)
sources (optional)
Query Parameter — restrict which sources are allowed for the returned publications
content (optional)
Query Parameter — whether to include publication text / html (significantly slows down response)
censor (optional)
Query Parameter — should be set when presenting the content on a public website
offset (optional)
Query Parameter — offset of first item to return format: int32
limit (optional)
Query Parameter — maximum number of items to return format: int32
output (optional)
Query Parameter — response format default: json

Return type

GenericResponse

Example data

Content-Type: application/json
{
  "newPos" : "aeiou",
  "publications" : [ {
    "date" : "2000-01-23",
    "internal" : "{}",
    "source" : { },
    "title" : "aeiou",
    "mentionedCompanies" : "",
    "structure" : {
      "topics" : [ {
        "name" : "aeiou",
        "type" : "Entry",
        "value" : "aeiou"
      } ]
    },
    "filings" : [ {
      "city" : "aeiou",
      "id" : "aeiou"
    } ],
    "publisher" : {
      "relatedPersons" : "",
      "financials" : "",
      "address" : {
        "country" : "aeiou",
        "lng" : 6.027456183070403,
        "city" : "aeiou",
        "street" : "aeiou",
        "postalCode" : "aeiou",
        "lat" : 0.8008281904610115
      },
      "subject" : "aeiou",
      "extras" : [ {
        "sourceUrl" : "aeiou",
        "sourceName" : "aeiou",
        "items" : [ {
          "formattedHtmlValue" : "aeiou",
          "name" : "aeiou",
          "id" : "aeiou",
          "value" : "aeiou"
        } ]
      } ],
      "history" : {
        "financials" : [ {
          "date" : "2000-01-23",
          "note" : {
            "html" : "aeiou",
            "text" : "aeiou"
          },
          "consolidated" : true,
          "formattedDate" : "aeiou",
          "source" : {
            "snippets" : [ {
              "title" : "aeiou",
              "contentType" : "aeiou",
              "content" : "aeiou"
            } ],
            "publicationId" : "aeiou",
            "publicationTitle" : "aeiou",
            "publicationDate" : "2000-01-23",
            "auditorName" : "aeiou"
          },
          "items" : [ {
            "note" : "aeiou",
            "unit" : "aeiou",
            "name" : "aeiou",
            "formattedValue" : "aeiou",
            "id" : "aeiou",
            "value" : 1.4658129805029452
          } ]
        } ],
        "addresses" : [ {
          "date" : "2000-01-23",
          "address" : ""
        } ],
        "names" : [ {
          "date" : "2000-01-23",
          "name" : ""
        } ],
        "registers" : [ {
          "date" : "2000-01-23",
          "register" : ""
        } ]
      },
      "relatedCompanies" : {
        "items" : [ {
          "person" : {
            "relatedCompanies" : "",
            "address" : "",
            "deceased" : true,
            "birthYear" : 5,
            "name" : {
              "firstName" : "aeiou",
              "lastName" : "aeiou",
              "title" : "aeiou"
            },
            "id" : "aeiou",
            "birthDate" : "2000-01-23"
          },
          "roles" : [ {
            "date" : "2000-01-23",
            "name" : "aeiou",
            "demotion" : true,
            "type" : "Publisher",
            "dir" : "None",
            "announce" : true,
            "group" : "Succession"
          } ],
          "company" : ""
        } ]
      },
      "name" : {
        "name" : "aeiou",
        "legalForm" : "aeiou"
      },
      "id" : "aeiou",
      "terminated" : true,
      "events" : {
        "items" : [ {
          "date" : "2000-01-23",
          "description" : "aeiou",
          "type" : "aeiou"
        } ]
      },
      "register" : {
        "city" : "aeiou",
        "uniqueKey" : "aeiou",
        "id" : "aeiou"
      },
      "status" : "active"
    },
    "html" : "aeiou",
    "id" : "aeiou",
    "sourceName" : "aeiou",
    "text" : "aeiou",
    "category" : "aeiou",
    "mentionedPersons" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response GenericResponse

Up
get /pub/v1/publications
(pubV1PublicationsGet)
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.

Query parameters

minTimestamp (optional)
Query Parameter — minimum datetime publication was added to the database format: date-time
maxTimestamp (optional)
Query Parameter — maximum datetime publication was added to the database format: date-time
minDate (optional)
Query Parameter — DEPRECATED - please use minTimestamp instead format: date
maxDate (optional)
Query Parameter — DEPRECATED - please use maxTimestamp instead format: date
sources (optional)
Query Parameter — restrict which sources are allowed for the returned publications
content (optional)
Query Parameter — whether to include publication text / html
pos (optional)
Query Parameter — if additional results shall be downloaded, set this to the value of the newPos attribute of the previous response
censor (optional)
Query Parameter — should be set when presenting the content on a public website
output (optional)
Query Parameter — response format default: json

Return type

GenericResponse

Example data

Content-Type: application/json
{
  "newPos" : "aeiou",
  "publications" : [ {
    "date" : "2000-01-23",
    "internal" : "{}",
    "source" : { },
    "title" : "aeiou",
    "mentionedCompanies" : "",
    "structure" : {
      "topics" : [ {
        "name" : "aeiou",
        "type" : "Entry",
        "value" : "aeiou"
      } ]
    },
    "filings" : [ {
      "city" : "aeiou",
      "id" : "aeiou"
    } ],
    "publisher" : {
      "relatedPersons" : "",
      "financials" : "",
      "address" : {
        "country" : "aeiou",
        "lng" : 6.027456183070403,
        "city" : "aeiou",
        "street" : "aeiou",
        "postalCode" : "aeiou",
        "lat" : 0.8008281904610115
      },
      "subject" : "aeiou",
      "extras" : [ {
        "sourceUrl" : "aeiou",
        "sourceName" : "aeiou",
        "items" : [ {
          "formattedHtmlValue" : "aeiou",
          "name" : "aeiou",
          "id" : "aeiou",
          "value" : "aeiou"
        } ]
      } ],
      "history" : {
        "financials" : [ {
          "date" : "2000-01-23",
          "note" : {
            "html" : "aeiou",
            "text" : "aeiou"
          },
          "consolidated" : true,
          "formattedDate" : "aeiou",
          "source" : {
            "snippets" : [ {
              "title" : "aeiou",
              "contentType" : "aeiou",
              "content" : "aeiou"
            } ],
            "publicationId" : "aeiou",
            "publicationTitle" : "aeiou",
            "publicationDate" : "2000-01-23",
            "auditorName" : "aeiou"
          },
          "items" : [ {
            "note" : "aeiou",
            "unit" : "aeiou",
            "name" : "aeiou",
            "formattedValue" : "aeiou",
            "id" : "aeiou",
            "value" : 1.4658129805029452
          } ]
        } ],
        "addresses" : [ {
          "date" : "2000-01-23",
          "address" : ""
        } ],
        "names" : [ {
          "date" : "2000-01-23",
          "name" : ""
        } ],
        "registers" : [ {
          "date" : "2000-01-23",
          "register" : ""
        } ]
      },
      "relatedCompanies" : {
        "items" : [ {
          "person" : {
            "relatedCompanies" : "",
            "address" : "",
            "deceased" : true,
            "birthYear" : 5,
            "name" : {
              "firstName" : "aeiou",
              "lastName" : "aeiou",
              "title" : "aeiou"
            },
            "id" : "aeiou",
            "birthDate" : "2000-01-23"
          },
          "roles" : [ {
            "date" : "2000-01-23",
            "name" : "aeiou",
            "demotion" : true,
            "type" : "Publisher",
            "dir" : "None",
            "announce" : true,
            "group" : "Succession"
          } ],
          "company" : ""
        } ]
      },
      "name" : {
        "name" : "aeiou",
        "legalForm" : "aeiou"
      },
      "id" : "aeiou",
      "terminated" : true,
      "events" : {
        "items" : [ {
          "date" : "2000-01-23",
          "description" : "aeiou",
          "type" : "aeiou"
        } ]
      },
      "register" : {
        "city" : "aeiou",
        "uniqueKey" : "aeiou",
        "id" : "aeiou"
      },
      "status" : "active"
    },
    "html" : "aeiou",
    "id" : "aeiou",
    "sourceName" : "aeiou",
    "text" : "aeiou",
    "category" : "aeiou",
    "mentionedPersons" : ""
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response GenericResponse

Up
get /search/v1/power
(searchV1PowerGet)
power search: supports geo and financial criteria

Query parameters

name (optional)
Query Parameter — company name or empty
address (optional)
Query Parameter — address or geo coordinates
maxDistanceKm (optional)
Query Parameter — maximum distance from given address format: double
status (optional)
Query Parameter — list of valid statuses (active, terminated, liquidation)
financialId (optional)
Query Parameter — list of financial ids for financial filtering (see user guide)
lowerBound (optional)
Query Parameter — list of lower bounds for financial filterings (see user guide) format: double
upperBound (optional)
Query Parameter — list of upper bounds for financial filterings (see user guide) format: double
pos (optional)
Query Parameter — if additional results shall be downloaded, set this to the value of the newPos attribute of the previous response
censor (optional)
Query Parameter — should be set when presenting the content on a public website
limit (optional)
Query Parameter — maximum number of items to return format: int32
output (optional)
Query Parameter — response format default: json

Return type

SearchResults

Example data

Content-Type: application/json
{
  "total" : 7,
  "offset" : 5,
  "nextPos" : "aeiou",
  "nextOffset" : 2,
  "results" : [ {
    "person" : "",
    "publication" : {
      "date" : "2000-01-23",
      "internal" : "{}",
      "source" : { },
      "title" : "aeiou",
      "mentionedCompanies" : "",
      "structure" : {
        "topics" : [ {
          "name" : "aeiou",
          "type" : "Entry",
          "value" : "aeiou"
        } ]
      },
      "filings" : [ {
        "city" : "aeiou",
        "id" : "aeiou"
      } ],
      "publisher" : "",
      "html" : "aeiou",
      "id" : "aeiou",
      "sourceName" : "aeiou",
      "text" : "aeiou",
      "category" : "aeiou",
      "mentionedPersons" : ""
    },
    "company" : {
      "relatedPersons" : "",
      "financials" : "",
      "address" : {
        "country" : "aeiou",
        "lng" : 6.027456183070403,
        "city" : "aeiou",
        "street" : "aeiou",
        "postalCode" : "aeiou",
        "lat" : 0.8008281904610115
      },
      "subject" : "aeiou",
      "extras" : [ {
        "sourceUrl" : "aeiou",
        "sourceName" : "aeiou",
        "items" : [ {
          "formattedHtmlValue" : "aeiou",
          "name" : "aeiou",
          "id" : "aeiou",
          "value" : "aeiou"
        } ]
      } ],
      "history" : {
        "financials" : [ {
          "date" : "2000-01-23",
          "note" : {
            "html" : "aeiou",
            "text" : "aeiou"
          },
          "consolidated" : true,
          "formattedDate" : "aeiou",
          "source" : {
            "snippets" : [ {
              "title" : "aeiou",
              "contentType" : "aeiou",
              "content" : "aeiou"
            } ],
            "publicationId" : "aeiou",
            "publicationTitle" : "aeiou",
            "publicationDate" : "2000-01-23",
            "auditorName" : "aeiou"
          },
          "items" : [ {
            "note" : "aeiou",
            "unit" : "aeiou",
            "name" : "aeiou",
            "formattedValue" : "aeiou",
            "id" : "aeiou",
            "value" : 1.4658129805029452
          } ]
        } ],
        "addresses" : [ {
          "date" : "2000-01-23",
          "address" : ""
        } ],
        "names" : [ {
          "date" : "2000-01-23",
          "name" : ""
        } ],
        "registers" : [ {
          "date" : "2000-01-23",
          "register" : ""
        } ]
      },
      "relatedCompanies" : {
        "items" : [ {
          "person" : {
            "relatedCompanies" : "",
            "address" : "",
            "deceased" : true,
            "birthYear" : 5,
            "name" : {
              "firstName" : "aeiou",
              "lastName" : "aeiou",
              "title" : "aeiou"
            },
            "id" : "aeiou",
            "birthDate" : "2000-01-23"
          },
          "roles" : [ {
            "date" : "2000-01-23",
            "name" : "aeiou",
            "demotion" : true,
            "type" : "Publisher",
            "dir" : "None",
            "announce" : true,
            "group" : "Succession"
          } ],
          "company" : ""
        } ]
      },
      "name" : {
        "name" : "aeiou",
        "legalForm" : "aeiou"
      },
      "id" : "aeiou",
      "terminated" : true,
      "events" : {
        "items" : [ {
          "date" : "2000-01-23",
          "description" : "aeiou",
          "type" : "aeiou"
        } ]
      },
      "register" : {
        "city" : "aeiou",
        "uniqueKey" : "aeiou",
        "id" : "aeiou"
      },
      "status" : "active"
    }
  } ],
  "censored" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response SearchResults

Up
get /search/v1/suggest
(searchV1SuggestGet)
auto complete: provides quick company and person suggestions for given input query

Query parameters

query (required)
Query Parameter — the query string
censor (optional)
Query Parameter — should be set when presenting the content on a public website
limit (optional)
Query Parameter — maximum number of items to return format: int32
output (optional)
Query Parameter — response format default: json

Return type

SearchResults

Example data

Content-Type: application/json
{
  "total" : 7,
  "offset" : 5,
  "nextPos" : "aeiou",
  "nextOffset" : 2,
  "results" : [ {
    "person" : "",
    "publication" : {
      "date" : "2000-01-23",
      "internal" : "{}",
      "source" : { },
      "title" : "aeiou",
      "mentionedCompanies" : "",
      "structure" : {
        "topics" : [ {
          "name" : "aeiou",
          "type" : "Entry",
          "value" : "aeiou"
        } ]
      },
      "filings" : [ {
        "city" : "aeiou",
        "id" : "aeiou"
      } ],
      "publisher" : "",
      "html" : "aeiou",
      "id" : "aeiou",
      "sourceName" : "aeiou",
      "text" : "aeiou",
      "category" : "aeiou",
      "mentionedPersons" : ""
    },
    "company" : {
      "relatedPersons" : "",
      "financials" : "",
      "address" : {
        "country" : "aeiou",
        "lng" : 6.027456183070403,
        "city" : "aeiou",
        "street" : "aeiou",
        "postalCode" : "aeiou",
        "lat" : 0.8008281904610115
      },
      "subject" : "aeiou",
      "extras" : [ {
        "sourceUrl" : "aeiou",
        "sourceName" : "aeiou",
        "items" : [ {
          "formattedHtmlValue" : "aeiou",
          "name" : "aeiou",
          "id" : "aeiou",
          "value" : "aeiou"
        } ]
      } ],
      "history" : {
        "financials" : [ {
          "date" : "2000-01-23",
          "note" : {
            "html" : "aeiou",
            "text" : "aeiou"
          },
          "consolidated" : true,
          "formattedDate" : "aeiou",
          "source" : {
            "snippets" : [ {
              "title" : "aeiou",
              "contentType" : "aeiou",
              "content" : "aeiou"
            } ],
            "publicationId" : "aeiou",
            "publicationTitle" : "aeiou",
            "publicationDate" : "2000-01-23",
            "auditorName" : "aeiou"
          },
          "items" : [ {
            "note" : "aeiou",
            "unit" : "aeiou",
            "name" : "aeiou",
            "formattedValue" : "aeiou",
            "id" : "aeiou",
            "value" : 1.4658129805029452
          } ]
        } ],
        "addresses" : [ {
          "date" : "2000-01-23",
          "address" : ""
        } ],
        "names" : [ {
          "date" : "2000-01-23",
          "name" : ""
        } ],
        "registers" : [ {
          "date" : "2000-01-23",
          "register" : ""
        } ]
      },
      "relatedCompanies" : {
        "items" : [ {
          "person" : {
            "relatedCompanies" : "",
            "address" : "",
            "deceased" : true,
            "birthYear" : 5,
            "name" : {
              "firstName" : "aeiou",
              "lastName" : "aeiou",
              "title" : "aeiou"
            },
            "id" : "aeiou",
            "birthDate" : "2000-01-23"
          },
          "roles" : [ {
            "date" : "2000-01-23",
            "name" : "aeiou",
            "demotion" : true,
            "type" : "Publisher",
            "dir" : "None",
            "announce" : true,
            "group" : "Succession"
          } ],
          "company" : ""
        } ]
      },
      "name" : {
        "name" : "aeiou",
        "legalForm" : "aeiou"
      },
      "id" : "aeiou",
      "terminated" : true,
      "events" : {
        "items" : [ {
          "date" : "2000-01-23",
          "description" : "aeiou",
          "type" : "aeiou"
        } ]
      },
      "register" : {
        "city" : "aeiou",
        "uniqueKey" : "aeiou",
        "id" : "aeiou"
      },
      "status" : "active"
    }
  } ],
  "censored" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response SearchResults

Up
get /search/v1/universal
(searchV1UniversalGet)
universal search: provides best company and person matches for given input query

Query parameters

query (required)
Query Parameter — the query string
domain (optional)
Query Parameter — set to "company" for companies only, "person" for persons only, otherwise leave empty
pos (optional)
Query Parameter — if additional results shall be downloaded, set this to the value of the newPos attribute of the previous response
censor (optional)
Query Parameter — should be set when presenting the content on a public website
offset (optional)
Query Parameter — offset of first item to return format: int32
limit (optional)
Query Parameter — maximum number of items to return format: int32
output (optional)
Query Parameter — response format default: json

Return type

SearchResults

Example data

Content-Type: application/json
{
  "total" : 7,
  "offset" : 5,
  "nextPos" : "aeiou",
  "nextOffset" : 2,
  "results" : [ {
    "person" : "",
    "publication" : {
      "date" : "2000-01-23",
      "internal" : "{}",
      "source" : { },
      "title" : "aeiou",
      "mentionedCompanies" : "",
      "structure" : {
        "topics" : [ {
          "name" : "aeiou",
          "type" : "Entry",
          "value" : "aeiou"
        } ]
      },
      "filings" : [ {
        "city" : "aeiou",
        "id" : "aeiou"
      } ],
      "publisher" : "",
      "html" : "aeiou",
      "id" : "aeiou",
      "sourceName" : "aeiou",
      "text" : "aeiou",
      "category" : "aeiou",
      "mentionedPersons" : ""
    },
    "company" : {
      "relatedPersons" : "",
      "financials" : "",
      "address" : {
        "country" : "aeiou",
        "lng" : 6.027456183070403,
        "city" : "aeiou",
        "street" : "aeiou",
        "postalCode" : "aeiou",
        "lat" : 0.8008281904610115
      },
      "subject" : "aeiou",
      "extras" : [ {
        "sourceUrl" : "aeiou",
        "sourceName" : "aeiou",
        "items" : [ {
          "formattedHtmlValue" : "aeiou",
          "name" : "aeiou",
          "id" : "aeiou",
          "value" : "aeiou"
        } ]
      } ],
      "history" : {
        "financials" : [ {
          "date" : "2000-01-23",
          "note" : {
            "html" : "aeiou",
            "text" : "aeiou"
          },
          "consolidated" : true,
          "formattedDate" : "aeiou",
          "source" : {
            "snippets" : [ {
              "title" : "aeiou",
              "contentType" : "aeiou",
              "content" : "aeiou"
            } ],
            "publicationId" : "aeiou",
            "publicationTitle" : "aeiou",
            "publicationDate" : "2000-01-23",
            "auditorName" : "aeiou"
          },
          "items" : [ {
            "note" : "aeiou",
            "unit" : "aeiou",
            "name" : "aeiou",
            "formattedValue" : "aeiou",
            "id" : "aeiou",
            "value" : 1.4658129805029452
          } ]
        } ],
        "addresses" : [ {
          "date" : "2000-01-23",
          "address" : ""
        } ],
        "names" : [ {
          "date" : "2000-01-23",
          "name" : ""
        } ],
        "registers" : [ {
          "date" : "2000-01-23",
          "register" : ""
        } ]
      },
      "relatedCompanies" : {
        "items" : [ {
          "person" : {
            "relatedCompanies" : "",
            "address" : "",
            "deceased" : true,
            "birthYear" : 5,
            "name" : {
              "firstName" : "aeiou",
              "lastName" : "aeiou",
              "title" : "aeiou"
            },
            "id" : "aeiou",
            "birthDate" : "2000-01-23"
          },
          "roles" : [ {
            "date" : "2000-01-23",
            "name" : "aeiou",
            "demotion" : true,
            "type" : "Publisher",
            "dir" : "None",
            "announce" : true,
            "group" : "Succession"
          } ],
          "company" : ""
        } ]
      },
      "name" : {
        "name" : "aeiou",
        "legalForm" : "aeiou"
      },
      "id" : "aeiou",
      "terminated" : true,
      "events" : {
        "items" : [ {
          "date" : "2000-01-23",
          "description" : "aeiou",
          "type" : "aeiou"
        } ]
      },
      "register" : {
        "city" : "aeiou",
        "uniqueKey" : "aeiou",
        "id" : "aeiou"
      },
      "status" : "active"
    }
  } ],
  "censored" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A successful response SearchResults

Models

[ Jump to Methods ]

Table of Contents

  1. Address -
  2. AddressHistoryItem -
  3. Company - Company
  4. CompanyHistory -
  5. CompanyName -
  6. CompanyNameHistoryItem -
  7. Event -
  8. EventType -
  9. Events -
  10. Extra -
  11. Extras -
  12. Filing -
  13. Financial -
  14. FinancialFilter -
  15. Financials -
  16. FinancialsNote -
  17. FinancialsSource -
  18. GenericResponse -
  19. Money -
  20. Order -
  21. OrderItem -
  22. Person -
  23. PersonName -
  24. Product -
  25. Publication -
  26. PublicationSource -
  27. PublicationStructure -
  28. Register -
  29. RegisterHistoryItem -
  30. Relation -
  31. Relations -
  32. Role -
  33. SearchResult -
  34. SearchResults -
  35. SourceSnippet -
  36. Topic -

Address - Up

street (optional)
String street and house number
postalCode (optional)
String postal code
city
String city
country
String two-letter ISO country code
lat (optional)
Double geo coordinates, latitude part format: double
lng (optional)
Double geo coordinates, longitude part format: double

AddressHistoryItem - Up

address
date (optional)
date since when the referred address is (known to be) in use format: date

Company - Company Up

All data for a particular company
id
String internal company id (do not store this id in an external database, it may change over time)
name
CompanyName name of the company
address
Address current address
register (optional)
Register register information
subject (optional)
String subject according to register filing (Unternehmensgegenstand)
terminated (optional)
Boolean company has been terminated
status (optional)
String current status of the company, where liquidation is the intermediate state before the final removal from the register (=terminated)
Enum:
active
liquidation
terminated
history (optional)
CompanyHistory earlier names, addresses, and register entries
financials (optional)
Financials financial performance indicators
events (optional)
Events relevant events in the history of the company
extras (optional)
array[Extras] extra data provided by 3rd parties
relatedCompanies (optional)
Relations related companies
relatedPersons (optional)
Relations related persons

CompanyHistory - Up

names (optional)
array[CompanyNameHistoryItem] name history of a company
addresses (optional)
array[AddressHistoryItem] adress history of a company
registers (optional)
array[RegisterHistoryItem] register entry history of a company
financials (optional)
array[Financials] historical financial data

CompanyName - Up

name (optional)
String name of a company
legalForm (optional)
String legal form (one of: A/S, AG, AG & Co. KG, AöR, Co. KG, d.o.o., e. K., e. V., eG, EWIV, gAG, GbR, gGmbH, GmbH, GmbH & Co. KG, gSE, gUG, Inh., InvAG, KG, KGaA, KGaA & Co. KG, Ltd., Ltd. & Co. KG, OHG, PartGG, plc, REITG, S.L., SCE, SCE, SCE mbH, SE, SE & Co. KG, Stiftung & Co. KG, UG, UG & Co. KG, VVaG)

CompanyNameHistoryItem - Up

name
date (optional)
date since when the referred company name is (known to be) in use format: date

Event - Up

event
type (optional)
String one of ...
date (optional)
date when it happened format: date
description (optional)
String human-readable description of what happend

EventType - Up

event type

Events - Up

list of events
items
array[Event] the list of events

Extra - Up

extra data item, typically provided by a 3rd party.
id
String common ids are: email, url, phone, fax, vatId, wz
name
String describing name in German language (for example, "E-Mail")
value
String actual value
formattedHtmlValue
String value formatted as an HTML string

Extras - Up

set of additional data, typically provided by 3rd parties.
sourceName (optional)
String name of the source
sourceUrl (optional)
String url of the source
items (optional)
array[Extra] extra data items in this set

Filing - Up

Court Filing (e.g., Insolvenzgericht Charlottenburg 36w IN 3284/16)
city (optional)
String city of the register court (e.g. Charlottenburg)
id
String ID of the court filing (e.g., 36w IN 3284/16)

Financial - Up

single financial number
id
String type of number (for example, revenue). Please see the document Finanz-Kennzahlentabelle for a complete list
name
String name in German language (for example, Umsatz)
value
Double actual value format: double
unit (optional)
String unit or currency (EUR, % or empty)
note (optional)
String optional note or comment with respect to the calculation of the financial
formattedValue
String value formatted as a string (German number formatting conventions)

FinancialFilter - Up

used to specify financial constraints for company queries
financialId (optional)
String id of the financial (e.g. "revenue")
lowerBound (optional)
Double value of the financial must be larger or equal to the lower bound format: double
upperBound (optional)
Double value of the financial must be smaller or equal to the upper bound format: double

Financials - Up

financial data
date
date reference date format: date
formattedDate
String date formatted as a german string
consolidated
Boolean true if the financial data refer to a consolidated balance (Konzernabschluss)
source (optional)
FinancialsSource source of financial data
items
array[Financial] list of financial numbers (maybe empty. If empty, see note for the reason)
note (optional)
FinancialsNote explaining numbers (or their absence)

FinancialsNote - Up

additional explanation of financials (or of their absence)
text
String explanation as plain text
html
String explanation as html

FinancialsSource - Up

source of financial data
publicationId (optional)
String internal publication ID
publicationTitle
String publication title such as "Jahresabschluss 2015"
publicationDate
date date the publication was published format: date
auditorName (optional)
String name of auditing company
snippets (optional)
array[SourceSnippet] excerpts from the original publication containing the financial data

GenericResponse - Up

newPos (optional)
publications (optional)

Money - Up

amount and currency
currency
String currency (three-letter code)
amount
Double amount as a number format: double
formattedValue
String amount and currency formatted as a human-readable string

Order - Up

result of an order
id (optional)
String string to identify the order
items (optional)

OrderItem - Up

information whether and where a product maybe downloaded
product (optional)
Product product bought
status
String whether the publication is ready for download
Enum:
waiting
ready
url (optional)
String url to download from (when the status is 'ready')
contentType (optional)
String mime type

Person - Up

id
String internal person id (do not store this id in an external database, it may change over time)
name
address (optional)
birthDate (optional)
date Birth date format: date
birthYear (optional)
Integer Sometimes only the birth years is known, but not the exact date format: int32
deceased (optional)
Boolean person is known to be dead
relatedCompanies (optional)
Relations Related companies

PersonName - Up

firstName (optional)
String first name(s)
lastName
String last name
title (optional)
String title

Product - Up

a publication that can be bought and downloaded
id
String string to identify a product when ordering for download
name
String name of the product
date (optional)
date publishing date format: date
price
Money cost of the product

Publication - Up

id
String interne ID
date
date publishing date format: date
source
sourceName (optional)
String full name of source
category (optional)
String category under which publication was filed in the original source
title
String title of publication
text (optional)
String raw text of the publication
html (optional)
String text of publication in HTML format
publisher (optional)
Company company that published this publication
structure (optional)
PublicationStructure result of structural analysis
mentionedCompanies (optional)
Relations list of companies mentioned in this publication
mentionedPersons (optional)
Relations list of persons mentioned in this publication
filings (optional)
array[Filing] court filings (currently only: insolvency filings)
internal (optional)
Object additional data used for internal purposes

PublicationSource - Up

Source identifier:

PublicationStructure - Up

result of the structural analysis of a publication
topics (optional)
array[Topic] topics of the publication

Register - Up

register entry information (e.g., Amtsgericht Hamburg HRB 9999)
city (optional)
String city of the register court (e.g. Hamburg)
id
String ID of the register filing (e.g. HRB 9999)
uniqueKey (optional)
String unique numerical key for repeatably unique identification of the register entry

RegisterHistoryItem - Up

register
date (optional)
date since when this registry entry is valid format: date

Relation - Up

relation of a company or person to another company or person
company (optional)
Company Related company (only base data - id, name, address, register)
person (optional)
Person Related person (only base data - id, first and last name, adress, birth date)
roles
array[Role] description of the type of the relation

Relations - Up

list of related companies / persons
items

Role - Up

description of the type of a relation
date (optional)
date date format: date
name
String German description
demotion (optional)
Boolean true if the relation ends at the given date (e.g., "Aussscheiden eines Geschäftsführers")
announce (optional)
Boolean true if the relation might be preliminary ("Ankündigung")
type
String internal identifier
Enum:
Publisher
Umwandlung
Sitzverlegung
Hgb264
Komplementaer
Beherrschung
Gewinnnabfuehrung
Teilgewinnnabfuehrung
Gewinngemeinschaft
Betriebspacht
Betriebsueberlassung
Uebernahme
Verschmolzen
Ausgliederung
Abspaltung
Inhaber
Paechter
PersoenlichHaftenderGesellschafter
Vorstandsvorsitzender
Vorstand
Geschaeftsfuehrer
StellvertretenderGeschaeftsfuehrer
GeschaeftsfuehrenderDirektor
Notgeschaeftsfuehrer
StaendigerVertreter
Partner
Director
Liquidator
Aufsichtsrat
Prokura
Handelnd
Unknown
group
String internal group identifier
Enum:
Succession
Control
Merger
Personal
Other
dir (optional)
String Direction. The exact interpretation depends of the value of the field "group". Case "succession" - older company is "Source". Case "merger" - Sold company is "Source", Buyer is target "Target". Case "control" - controlling company is "Source".
Enum:
None
Source
Target
Bi

SearchResult - Up

company, person or publication that is result of a search
company (optional)
Company company found
person (optional)
Person person found
publication (optional)
Publication publication found

SearchResults - Up

search results
results (optional)
array[SearchResult] list of results
censored (optional)
Boolean true if results have been omitted because of censoring
offset (optional)
Integer offset of result array in all results format: int32
nextOffset (optional)
Integer offset to retrieve next batch of results format: int32
nextPos (optional)
String position to retrieve next batch of results
total (optional)
Integer total number of results (usually, this number is not available, unfortunately) format: int32

SourceSnippet - Up

excerpts from an original publication
title
String title
content
String text
contentType (optional)
String content format, usually "text/html"

Topic - Up

topic of a publication
name (optional)
String German description (e.g., "Stammkapital")
value (optional)
String accompanying value (e.g., €100.000,-)
type (optional)
String internal identificator for the topic
Enum:
Entry
Continuation
Name
Headquarters
Address
Capital
Subject
Contract
Statute
LegalForm
Proxy
ListOfBoardMembers
ConvertibleBonds
Liquidation
Exit
Aufhebung
Verguetung
AnkuendigungRestschuldbefreiung
Restschuldbefreiung
EinstellungMangelsMasse
Eroeffnung
Masseunzulänglichkeit
Pruefungstermin
Schlusstermin
VerteilungsVerzeichnis
AbweisungMangelsMasse
TreuhaenderBestimmung
Insolvenzverwalter
VorlaufigerInsolvenzverwalter
Sicherungsmassnahme
InsolvenzSonstiges