API Documentation: version 1.2

Introduction

This documentation covers the Open Risk Exchange REST API. The API provides the credit scores available on the Open Risk Exchange website as data in JSON format.

Access to the credit scores is free via the portal for low volume users and academic research projects but is restricted with certain usage limits.

Requesting and using an API key increases these usage limits for the service. We have a range of pricing plans (see below) for high volume users.

Pricing

Basic API Plan


5,000 API calls / month

Annual: GBP 10,000 / year

Monthly: GBP 1,000 / month

Corporate API Plan


50,000 API calls / month

Annual: GBP 77,500 / year

Monthly: GBP 7,750 / month

Enterprise API Plan


+50,000 API calls / month

Pricing on demand

Email us for a quote

Academic Research


If you are a researcher or student working on a non-commercial, academic project and would like API access, please get in touch.

Please note that all prices are exclusive of VAT.

Request API access

Please send an email to team@openriskexchange.com if you would like to request API access to the credit scores detailing which subscription package fits your requirements.

Getting started with the Open Risk Exchange API

Authentication

Authentication is achieved by a simple API token that needs to be submitted with every request in the query parameters.

Method calls

The requests should be sent to the url https://api.openriskexchange.com.

GET /business_closure

To get the probability of business closure for a company at a given point in time, post a HTTP GET request, providing the following information:

  • user name ("user")
  • valid authentication token ("token")
  • company registration number as per Companies House (8 characters) ("cid")
  • year (as an integer) ("year")
  • month (as an integer) ("month")

The information needs to be submitted as following:

{
    "user": "user_name",
    "token": "xxxxx",
    "cid": "SC555815",
    "year": 2017,
    "month": 9
}

You can test the API by entering the following curl command into your terminal:

curl -H "Content-Type: application/json" -X GET -d '{"user": "user_name", "token": "xxxxx", "cid": "SC555815", "year": 2017, "month": 9}' https://api.openriskexchange.com/business_closure

The expected response is:

{"cid": "SC555815", "year": 2017, "month": 9, "probability_type": "business_closure", "probability": 0.12021485300000463}

GET /insolvency

To get the probability of insolvency for a company at a given time, post a HTTP GET request, providing the following information:

  • user name ("user")
  • valid authentication token ("token")
  • company registration number as per Companies House (8 characters) ("cid")
  • year (as an integer) ("year")
  • month (as an integer) ("month")

The information needs to be submitted as following:

{
    "user": "user_name",
    "token": "xxxxx",
    "cid": "SC555815",
    "year": 2017,
    "month": 9
}

You can test the API by entering the following curl command into your terminal:

curl -H "Content-Type: application/json" -X GET -d '{"user": "user_name", "token": "xxxxx", "cid": "SC555815", "year": 2017, "month": 9}' https://api.openriskexchange.com/insolvency

The expected response is:

{"cid": "SC555815", "year": 2017, "month": 9, "probability_type": "insolvency", "probability": 0.002197808028179421}

Response Codes

Code Text Description
200 OK Success!
400 Incorrect request The request was invalid or cannot be otherwise served.
403 Unauthorized Incorrect user name or token.
404 Not Found No results. Make sure that cid, year and month are correct.
404 Incorrect probability_type Correct probability types: business_closure or insolvency.
422 Unprocessable Entity Incorrect parameters in the request json.

Current Score

In addition to specifying the month for a request, the API also allows for requesting the most recent probability for a certain company.

The information needs to be submitted as following:

{
    "user": "user_name",
    "token": "xxxxx",
    "cid": "SC555815",
    "current": "true"
}

You can test the API by entering the following curl command into your terminal:

curl -H "Content-Type: application/json" -X GET -d '{"user": "user_name", "token": "xxxxx", "cid": "SC555815", "current": "true"}' https://api.openriskexchange.com/business_closure