IDEX Data API Report3

IDEX Data API - Report 3

Retrieve data report 3 API.

Overview: In this API you will send an HTTP request with a date for which you want the report. You will get back a zipped CSV file. The file creation process may take a few minutes.

Input Parameters

Note: you must use a valid Api Key that provides access to this service.
There are many possible parameters for this endpoint. The input can either be abbreviated or fully named. All filters are case-insensitive.

Sections	Format	Mandatory
authentication_details	JSON Object	Yes
parameters	JSON Object	Yes

Authentication Parameter	Example	Format	Mandatory
api_key	HNNSSA1223311	String	Yes
api_secret	DDccdaaedf123	String	Yes

Parameter object:

Parameter	Details	Format
report_date	String of date. Format "yyyy-MM-dd" E.g 2021-07-24. Dates available according to service contract.	String

Error Codes

Common error codes

2001

Missing authentication section in JSON

2002

Missing paramaters section in JSON

3112

Missing required fields

3113

Date in wrong format

3114

Report not available

3115

Report date not available per service agreement

Sample Request

HTTP JSON

Endpoint: https://api.idexonline.com/idexdataapi/api/getreport3

{
    "authentication_details": {
        "api_key":"yourapikeyhnnGsa1223311",
        "api_secret":"yourapisecretbDccDaaedf123"
    },
    "parameters": {
        "report_date": "2021-01-18"
    }
}

Sample Response

JSON Data / Zipped CSV

The response will be JSON if there is an error, and a filestream if all is good.

CSV Format

CSV

Grading Lab

Shape

Carat

Color

Clarity

Make (Cut Grade)

Polish

Symmetry

Fluorescence Intensity

Price Per Carat USD

Total Price USD

Country

Day

Month

Year

1333119260

GIA

Round

0.4

SI1

Excellent

None

948

379.2

Belgium

2020

1223319261

GIA

Round

0.51

SI1

Very Good

Excellent

Faint

1620

648

Hong Kong

2020

1383321263

GIA

Round

0.62

SI2

Very Good

Faint

1463

585.2

Hong Kong

2020