HomeMore
Your Membership
Home
Your Membership
Live Charts   Statistics   CR World Map   CR Report API   API Documentation

Report API Documentation

Documentation for the CR Report API.

Who can use the CR Report API?

You have to have Research or Full Membership to use the API. You also need an API Token, a code which you include in the API call that identifies you. You can get your API Token from Your Membership.

Rate Limits

by default, you can make 50 API calls per calendar month, reset on the last day of the month. For further usage, contact us at info@corporateregister.com.

API Methods

At present, we have two main API methods. To discuss custom methods, contact us at info@corporateregister.com.
getLatest
Returns the latest 30 reports by sector.
Example
Arguments
api_token
Your API Token. If you don't have an API Token, get one here. Required.
sector
An industry sector. Spaces should be url encoded, that is replaced with %20. Required.
format
Values are XML or JSON. The default is XML.
callback
Allows you to add a function wrapper when using JSON.
Error codes
400
Bad request, invalid parameter. You have a missing or invalid argument.
401
API token was missing or invalid. You have a missing or invalid API Token.
403
The request is forbidden. You've hit your rate limit or don't have the correct permissions.
getOrg
Returns the reports published by an organisation.
Example
Arguments
api_token
Your API Token. If you don't have an API Token, get one here. Required.
org
A reporting organisation. Spaces should be url encoded, that is replaced with %20. Required.
format
Values are XML or JSON. The default is XML.
callback
Allows you to add a function wrapper when using JSON.
Error codes
400
Bad request, invalid parameter. You have a missing or invalid argument.
401
API token was missing or invalid. You have a missing or invalid API Token.
403
The request is forbidden. You've hit your rate limit or don't have the correct permissions.