Key concepts

REST API

REST stands for "REpresentational State Transfer". It means that all the data offered by the API is expressed as a simple URL. For example, to get the latest data for the "latest" (or snapshot) service, you would use this URL:

{ApiServerUrl}/${namespace}/${entity}/latest

Where the dataset is identified by a namespace string and the relevant collection of data is represented by an Entity string.

Namespaces

All REST API data products are represented by short lowercase namespaces (the namespace can also include numbers and underscores). This namespace string appears in the path for all the REST API URLs for that data set.

No side effects

Each call to the REST API has no effects on subsequent calls to the service. This allows a more scalable service, and it reduces the complexity of the API.

Note: An exception to this is the first call you make, where you login with your credentials and obtain an API key that must be used in all subsequent requests.

API key

Use your username and password to obtain an API Key from this URL:

{ApiServerUrl}/apikey

Data formats

The REST API can return data in XML and JSON. For the data sets that are "flat" (that is, they can be represented as a simple table with rows columns), the API also offers CSV as a response format where applicable.

Consistent data structure

All data in the API is represented by named fields such as isin or id, which are grouped into entities like ${entity}. A field may be a reference to another entity so for some data sets the data forms a branching, tree-like structure.

All fields are documented on the REST API Console and in this guide.

REST API Console

You can explore the REST API interactively in the REST API Console by opening the one of the following URLs in a browser:

UAT: https://api-uat.ihsmarkit.com

Production: https://api.ihsmarkit.com

Note: The UAT URL is for development and testing purposes, while the production URL is for tested production processes only. Both URLs have the same data.

The REST API Console is purely the REST API with responses in HTML format. You can change from the interactive console view to a pure data response suitable for application integration simply by changing the "format" parameter of the requests from HTML to JSON. In addition, the Console includes a full OpenAPI specification of the REST API.

Back to help overview