POST
/
v1
/
crawl
/
single
curl --request POST \
  --url https://api.openregisters.com/v1/crawl/single \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "register_number": 253035,
  "registergericht": "",
  "register_type": "HRB",
  "frequency": 123,
  "priority": false
}'
{
  "request_id": "<string>",
  "status": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "close_time": "2023-11-07T05:31:56Z",
  "execution_time": 123
}

Authorizations

​
X-API-Key
string
header
required

Sign up at Openregisters.com to get an API key

Body

application/json

Model representing a company crawl schedule.

Attributes: register_number: The company's register number registergericht: The court ID where the company is registered register_type: The type of register (e.g., HRB, HRA, GnR, etc.) frequency: How often the company should be crawled in hours

​
register_number
integer
default:253035
Required range: x > 0
​
registergericht
string
default:
​
register_type
string
default:HRB
​
frequency
integer | null
​
priority
boolean
default:false

Response

200
application/json
Successful Response
​
request_id
string
required
​
status
string
required
​
start_time
string | null
required
​
close_time
string | null
required
​
execution_time
integer | null
required