Business Monitor API (v0.5)

The Business Monitor API is a JSON-based API that implements responses following the JSON:API specification (see jsonapi.org for reference).

The API is available at https://api.business-monitor.ch.

Quick start

Grab your API key and try with curl on the command line:

curl -H "Authorization: Bearer your_api_key" https://api.business-monitor.ch/v0/companies/CHE283912112

Authentication

All requests must be authenticated with the user's API key, with the header Authorization: Bearer api_key.

Resources

Companies

Resource Description
GET /v0/companies/:id Get the company data (includes Commerce Register data)
GET /v0/companies/:id/commerce_register_data DEPRECATED Get the Commerce Register data for a specific company
GET /v0/companies/changed_on/:date Get companies for which there was a commerce register data change on a specific date (up to 7 days ago). Only includes companies previously fetched using other endpoints.
GET /v0/companies/search_by_name Search companies by name. Supports fuzziness. Responds with a maximum of 30 results.

Health checks

Resource Description
GET /v0/health_check Check the API is responding, without using quota. Responds with the company data for Novertur International SA.

Physical persons

Resource Description
GET /v0/physical_persons/:id Get a specific physical person.
GET /v0/physical_persons/search_by_name Search physical persons by name. Supports fuzziness. Responds with a maximum of 30 results.

Relationships

Resource Description
GET /v0/companies/:company_id/relationships Get relationships for a specific company.

Shab publications

Resource Description
GET /v0/companies/:company_id/shab_publications Get SHAB publications for a specific company.

Website pages

Resource Description
GET /v0/website_pages/:id Get a specific website page.

Websites

Resource Description
GET /v0/websites/:id Get a specific website.