Skip to main content
POST
/
api
/
prh
/
companies
/
search
/prh/companies/search
curl --request POST \
  --url https://api.anysite.io/api/prh/companies/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "name": "Nokia",
  "location": "Espoo",
  "post_code": "02610",
  "main_business_line": "70100",
  "business_id_registration_start": "2020-01-01",
  "business_id_registration_end": "2020-12-31",
  "registration_date_start": "2020-01-01",
  "registration_date_end": "2020-12-31"
}
'
[
  {
    "@type": "@prh_company",
    "business_id": {
      "@type": "@prh_business_id",
      "value": "<string>",
      "registration_date": "<string>",
      "source": "<string>"
    },
    "eu_id": {
      "@type": "@prh_eu_id",
      "value": "<string>",
      "source": "<string>"
    },
    "names": [],
    "main_business_line": {
      "@type": "@prh_main_business_line",
      "type": "<string>",
      "type_code_set": "<string>",
      "descriptions": []
    },
    "website": {
      "@type": "@prh_website",
      "url": "<string>",
      "registration_date": "<string>",
      "source": "<string>"
    },
    "company_forms": [],
    "company_situations": [],
    "registered_entries": [],
    "addresses": [],
    "public_notices": [],
    "trade_register_status": "<string>",
    "status": "<string>",
    "registration_date": "<string>",
    "last_modified": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required

Max number of results

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
name
string | null

Company name (full or partial)

Example:

"Nokia"

​
location
string | null

Registered home town / municipality

Example:

"Espoo"

​
post_code
string | null

Postal code of the registered address

Example:

"02610"

​
company_form
enum<string> | null

Legal company form

Available options:
AOY,
ASH,
ASY,
AY,
AYH,
ETS,
ETY,
SCE,
SCP,
HY,
KOY,
KVJ,
KVY,
KY,
OK,
OP,
OY,
OYJ,
SE,
SL,
SP,
SÄÄ,
TYH,
VOJ,
VOY,
VY,
VALTLL
​
main_business_line
string | null

Main line of business code (TOL 2008)

Example:

"70100"

​
business_id_registration_start
string | null

Earliest Business ID registration date, YYYY-MM-DD

Example:

"2020-01-01"

​
business_id_registration_end
string | null

Latest Business ID registration date, YYYY-MM-DD

Example:

"2020-12-31"

​
registration_date_start
string | null

Earliest trade register registration date, YYYY-MM-DD

Example:

"2020-01-01"

​
registration_date_end
string | null

Latest trade register registration date, YYYY-MM-DD

Example:

"2020-12-31"

Response

Successful Response

​
@type
string
default:@prh_company
​
business_id
PrhBusinessId · object
​
eu_id
PrhEuId · object
​
names
PrhName · object[]
​
main_business_line
PrhMainBusinessLine · object
​
website
PrhWebsite · object
​
company_forms
PrhCompanyFormItem · object[]
​
company_situations
PrhCompanySituation · object[]
​
registered_entries
PrhRegisteredEntry · object[]
​
addresses
PrhAddress · object[]
​
public_notices
PrhPublicNotice · object[]
​
trade_register_status
string | null
​
status
string | null
​
registration_date
string | null
​
last_modified
string | null