Quick Examples

  1. Documentation
  2. CEIC MACROECONOMIC DATA API
  3. API Documentation
  4. Quick Examples

NOTE: Please note that in order to test the API Call from the examples, you would need to add your token after “token=” in the API call.

Search for macroeconomic data

Use case: You are interested by Balance of Payments key data from France, Ireland and Poland. To retrieve such macroeconomic data from CEIC database in JSON format use the series/search functionality:

API Call:
https://api.ceicdata.com/v2//series/search?format=json&database=GLOBAL&country=PL%2C%20IE%2C%20FR&key_only=true&keyword=Balance%20of%20Payment&token=
Test_Example Interactive_Doc Use_Params

image

Get detailed information for set of macroeconomic data

Use case: You are interested by the daily deposits of Jordan. To retrieve detailed information about the related series we have follow the steps below:

  1. Get the list of CEIC series ids by using series/search functionality.
    API Call:
    https://api.ceicdata.com/v2//series/search?format=json&country=JO&keyword=deposit&status=T&frequency=D&name_only=true&token=
    Test_Example Interactive_Doc Use_Params
    image
  2. Get detailed information for each series, listed by series ID extracted from the previous step in CSV format by using series/{id} functionality.
    API Call:
    https://api.ceicdata.com/v2//series/130717708,349664002,349664102,349664302?format=csv&token=
    Test_Example Interactive_Doc Use_Params
    image

Get the latest updates on set of macroeconomic data

Use case: You are interested by the daily deposits data of Jordan which is updated after 2019-04-01 – this includes new data and revised after that period data. To retrieve the latest updates in JSON format use the series/{id}/data functionality

API Call:
https://api.ceicdata.com/v2//series/130717708,349664002,349664102,349664302/data?format=json&updated_after=2019-04-01&time_points_status=active&token=
Test_Example Interactive_Doc Use_Params

image

Get pre-defined insights from CEIC CDMNext platform

Use case: You are already CEIC subscriber with access to our CDMNext platform. You have saved insights documents with data which you use or you’re interested by insights created by our team. To download the insight data using API follow the steps below:

  1. List all insights under “My Insight” by using insights / search functionality.
    API Call:
    https://api.ceicdata.com/v2//insights/search?group=my&token=
    Test_Example Interactive_Doc Use_Params
    image
  2. Get the insight data using the insight ID extracted from the previous step and the insights/{id} functionality.
    API Call:
    https://api.ceicdata.com/v2//insights/c1554e8c-667f-4432-b501-009906473868?format=json&token=
    Test_Example Interactive_Doc Use_Params
    image
  3. Download the insight itself in PDF or XLSX format by using insights/{id}/download/{file_format} functionality.
    API Call:
    https://api.ceicdata.com/v2//insights/ea79e081-66eb-4fbc-9a1f-4baf404e3525/download/pdf?token=
    Test_Example Interactive_Doc Use_Params
    image

Get user manipulated data

Use case: You want to download CEIC data with applied transformation. The only available option up to now is to apply the data manipulation in CDMNext insight and download the data using API. To download user manipulated data follow the steps below:

  1. Apply ‘Aggregate (Yearly, Sum)' for series 384165717 and ‘Aggregate (Monthly, Avg))' for series 11321901 in saved Insight named "MyTestAPI"
  2. List all insights under “My Insight” by using insights/search functionality to find “MyTestAPI” insight.
    API Call:
    https://api.ceicdata.com/v2//insights/search?group=my&token=
    Test_Example Interactive_Doc Use_Params
    image
  3. Get the manipulated data from “MyTestAPI” insight by using insights/{id}/series/data functionality.
    API Call:
    https://api.ceicdata.com/v2//insights/c1554e8c-667f-4432-b501-009906473868/series/data?token=
    Test_Example Interactive_Doc Use_Params
    image

Build CEIC Layout tree

Use case: You would like to build CEIC layout tree on your local system. To build the tree follow the steps below:

  1. List all CEIC databases by using layout/database functionality.
    API Call:
    https://api.ceicdata.com/v2//layout/databases?token=
    Test_Example Interactive_Doc .
  2. Step_List_DB_Topic layout/database/{id}/topics functionality.
    API Call:
    https://api.ceicdata.com/v2//layout/databases/GLOBAL/topics?token=
    Test_Example Interactive_Doc Use_Params
    image
  3. List the sections under selected topic (for example: Albania) by using layout/topics/{id}/sections functionality.
    API Call:
    https://api.ceicdata.com/v2//layout/topics/TP40775/sections?token=
    Test_Example Interactive_Doc Use_Params
    image
  4. List the tables under selected section (for example: Production) by using layout/sections/{id}/tables functionality.
    API Call:
    https://api.ceicdata.com/v2//layout/sections/SC40788/tables?token=
    Test_Example Interactive_Doc Use_Params
    image
  5. List the series under the selected table (for example: Table: AL.B002: Production Volume Index: 2005=100) by using layout/tables/{id}/series functionality.
    API Call:
    https://api.ceicdata.com/v2//layout/tables/TB159222/series?token=
    Test_Example Interactive_Doc Use_Params
    image

Create a user defined filter

Use case: You want to create your own filter over CEIC data which can be used multiple times for searching and data retrieving. You want to retrieve “GDP” monthly key series data from Bulgaria in JSON format. To build filter use /filters functionality:

API Call:
https://api.ceicdata.com/v2//filters?format=json&token=
Test_Example Interactive_Doc Use_Params

image