API's for the diamond industry

Real Time Price JSON API

Overview: Via the Diamond Prices API, you may query our real time database of average asking prices for single polished diamonds, based on the following diamond parameters: Cut (Shape), Carat, Color, Clarity, Make (Cut Grade), Grading Lab.

HTTP

HTTP Request returns JSON
Endpoint: https://api.idexonline.com/realtimeprices/api/getprice

Input Parameters

There are a number of parameters that can be used for this API.
Parameter Allowed Values Format
shape Shape or Cut of the diamond.
Possible values: Round, Marquise, Pear, Oval, Heart, Emerald, Princess, Radiant, Triangle, Baguette, Asscher, Cushion
Mandatory field. 		String
weight Carat weight numeric between 0.08 and 9.99, e.g. 1.10.
Mandatory field. 		Decimal
color Possible values: D, E, F, G, H, I, J, K, L, M, N
Mandatory field. 		String
clarity Possible values: IF, VVS1, VVS2, VS1, VS2, SI1, SI2, SI3, I1, I2, I3
Mandatory field. 		String
cut_grade Cut grade or make.
Possible values: Ideal, Excellent, Very Good, Good, Fair, Poor
Optional field. 		String
grading_lab Grading lab or certificate issuer:
Possible values: AGS, CEGL, CGI, CGL, DCLA, EGL Asia, EGL Intl., EGL USA, GCAL, GIA, HRD, IGI
Optional field. 		String

Output Data Explained

The output format for this API is in JSON format.
For an overview of diamond properties click here.
Parameter Meaning Format
shape same as requested String
weight_group Description of the weight category String
min_weight minimum weight of category Decimal
max_weight maximum weight of category Decimal
color same as requested String
clarity same as requested String
cut_grade same as requested String
lab same as requested String
trade_price_per_carat Current Average Trading Price in USD / carat Decimal (nullable)
min_price_per_carat Average of lowest 10% asking price in USD / carat Decimal (nullable)
max_price_per_carat Average of 10% highest asking price in USD / carat Decimal (nullable)
avg_price_per_carat Average asking price of the last 3 months in USD / carat Decimal (nullable)
amount_of_diamonds Amount of diamonds now available Integer

Sample Request

HTTP GET
Endpoint: https://api.idexonline.com/realtimeprices/api/getprice 
{
	"authentication_details":{
		"api_key":"ABNSSA1223311",
		"api_secret":"SeCKeccdaaedf123"
	},
	"parameters":{
		"shape":"Round",
		"weight":1.10,
		"color":"E",
		"clarity":"VVS1",
		"cut_grade":"",
		"grading_lab":"GIA"
	}
}

Sample Response

XML String 
{
    "result_info": {
        "response_code": 0,
        "response_description": ""
    },
    "results": {
        "real_time_price": {
            "shape": "Round",
            "weight_group": "4/4 (1.00-1.49)",
            "min_weight": 1,
            "max_weight": 1.49,
            "color": "E",
            "clarity": "VVS1",
            "cut_grade": null,
            "lab": "GIA",
            "trade_price_per_carat": 9890,
            "min_price_per_carat": 5887,
            "max_price_per_carat": 12647,
            "avg_price_per_carat": 9260,
            "amount_of_diamonds": 646
        }
    }
}

© IDEX 2024, www.idexonline.com