Research Document API – Getting started – Sample Code

Integrating with IDC’s Research Document API (version 1) allows you to programmatically fetch IDC documents via RESTful endpoints.
Some documents might be related to your data services. These documents will still be available through this Research Documents API. To download the data itself use
Data API Getting started – Sample Code
Below are the basic steps to start using the API:

1. Obtain API Credentials: Request API access from IDC if you haven’t already – Setting up API Access.
2. REST API calls require two steps
   1. Logging in via a dedicated API endpoint using your account ID and a secret key. Upon successful authentication you will receive a bearer token you can use with all other calls.
   2. Retrieve specific information using the bearer token received via the log in API endpoint. You can list all documents available to you or download a specific document and related attachments.
3. Make Your First API Call: Using your client ID and the related secret API key, you can test connectivity by calling the login endpoint:

   curl -X POST https://research-api.idc.com/v1/login -H "Content-Type: application/json" -d '{"clientId": "your-client-id", "secret": "your-secret"}'

4. You can follow up by retrieving the list of documents available to you. You always have to specify the date range for the documents you want to obtain.

   curl -X GET "https://research-api.idc.com/v1/documents?lastUpdatedFrom=2020-01-01T00:00:00Z&lastUpdatedTo=2030-12-31T23:59:59Z" -H "Authorization: Bearer YOUR_AUTH_TOKEN" -H "Content-Type: application/json"

5. Automation: The above steps can be scripted. A common approach is to write a script (in Python, Bash, etc.) that runs periodically (e.g. hourly or daily) to check for new exports and download any new files. In the Research Document Synchronizer Sample Application, we provide more guidance and pseudo-code for such a script. By automating, you ensure your local data stays in sync with IDC’s latest releases.

That’s it! With your API key and these endpoints, you have the essentials to start pulling data. The API is RESTful and uses standard HTTP verbs and response codes. Next, you can explore more advanced usage like filtering data on the fly (Advanced Integration) or handling errors and versioning – see the API Documentation section for details.

Refer to Research Documents API for detailed end point specification.

This is only a preliminary version of the documentation.

The specification might change before the release.