Input Parameters

Parameter	Description
session_code	String, as received from login API.
item_type_id	Mandatory, Integer, 1=Natural Singles, 3=Natural Pairs, 11=Lab-Grown Singles
weight_from	Decimal
weight_to	Decimal
color_type_id	Mandatory, Integer, 1=Standard Colors, e.g. D,E,F, 2=Fancy Colors, 3=Treated Colors
standard_color_ids	Integer Array
fancy_color_intensities	Integer Array
fancy_color_overtones	Integer Array
fancy_colors	Integer Array
treated_colors	Integer Array
clarity_ids	Integer Array
cut_grades	Integer Array
polishes	Integer Array
symmetries	Integer Array
with_cert_file	Boolean
with_3d_viewer	Boolean
with_image	Boolean
with_video	Boolean
with_online_info	Boolean
grading_labs	Integer Array
grading_report_number	String, can be comma separated values.
show_any_lab	Boolean
show_without_lab	Boolean
fluorescence_intensities	Integer Array
fluorescense_colors	Integer Array
asking_price_per_carat_min	Decimal
asking_price_per_carat_max	Decimal
asking_price_total_min	Decimal
asking_price_total_max	Integer
trade_type_buy_now_only	Boolean
trade_type_allow_bids_only	Boolean
availabilities	Integer Array
countries	Integer Array
item_type_id	Integer
states	Integer Array
shades	Integer Array
shades_exclude	Integer Array
milkies	Integer Array
black_inclusions	Integer Array
eye_cleans	Integer Array
total_depth_min	Decimal
total_depth_max	Decimal
table_width_min	Decimal
table_width_max	Decimal
culet_sizes	Integer Array
culet_conditions	Integer Array
girdle_min	Integer
girdle_max	Integer
measurements_length_min	Decimal
measurements_length_max	Decimal
measurements_width_min	Decimal
measurements_width_max	Decimal
measurements_height_min	Decimal
measurements_height_max	Decimal
idex_diamond_ids	Integer Array
supplier_stock_number	String, can be comma separated values.
provenance_reports	Integer Array
brands	Integer Array
include_enhanced	Boolean
show_only_enhanced	Boolean
enhancements	Integer Array
max_age_hours	Integer
enhancements	Integer Array
supplier_ids	Integer Array, e.g. to show ones own diamonds.
show_favorites	Boolean, if you want to show all favorites, you can ommit item_type_id and color_type
sort_field_1	Integer
sort_field_2	Integer
sort_field_3	Integer
sort_field_4	Integer
sort_field_5	Integer
sort_field_6	Integer
result_limit	Integer, for paging, max amount of items to return. Optional
result_offset	Integer, for paging, how many items to skip. Optional.

Output Fields

Important notes on the output:

• The idea is to minimize the JSON size, so that the search will work faster. In order to achieve this, we include only the necessary fields. Most values will be abbreviated, exactly like you will want to display them to the user. The fields and values are therefore different from the full diamond details.
• item_type_id: 1 is natural single, 11 is lab grown single.
• status_id: 1 is active, 2 is sold.
• has_report_link: If true, you can open the link like this: https://mobapi.idexonline.com/diamondsearch/OpenReportLink?DiamondID={diamond_id}

Sample Request

HTTP JSON

Endpoint: https://mobapi.idexonline.com/diamondsearch/api/v2.0/search

{
  "session_code": "MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b",
  "item_type_id": 1,
  "weight_from": 1.1,
  "weight_to": 1.3,
  "color_type_id": 1,
  "standard_color_ids": [1,2,3],
  "clarity_ids": [5,6 ],
  "grading_labs": [2],
  "sort_field_1": 127,
  "result_limit": 50,
  "result_offset": 0
}

Sample Response

JSON Data with HTTP Code 200

If all goes well, the response will be an HTTP 200 code and the response_code in the JSON will be 0.

{
  "result_info": {
	"response_code": 0,
	"response_description": ""
  },
  "results": {
	"total_items_available": 593,
	"items_included": 50,
	"page_number": 1,
	"page_count": 12,
	"page_size": 50,
	"diamonds": [
	  {
		"row": 1,
		"diamond_id": 388292953,
		"item_type_id": 1,
		"status_id": 1,
		"shape_id": 3,
		"shape": "Round",
		"weight": 1.1,
		"color_short": "F",
		"clarity": "VVS2",
		"lab": "GIA",
		"grading_report_number": "6475661830",
		"cut_grade_short": "EX",
		"polish_short": "EX",
		"symmetry_short": "EX",
		"total_depth": 62.7,
		"table_width": 57,
		"fluorescence_short": "MED",
		"availability_short": "M",
		"price_per_carat": 4494,
		"price_total": 4943.4,
		"img_preview_url": "",
		"allow_buy_now": false,
		"has_report_link": true
	  },
	  {
		"row": 2,
		"diamond_id": 361517043,
		"item_type_id": 1,
		"status_id": 1,
		"shape_id": 3,
		"shape": "Round",
		"weight": 1.13,
		"color_short": "F",
		"clarity": "VVS2",
		"lab": "GIA",
		"grading_report_number": "7461874912",
		"cut_grade_short": "EX",
		"polish_short": "EX",
		"symmetry_short": "EX",
		"total_depth": 62.5,
		"table_width": 56,
		"fluorescence_short": "STG",
		"availability_short": "GA",
		"price_per_carat": 4601,
		"price_total": 5199.13,
		"img_preview_url": "https://idvm.s3.amazonaws.com/img/361517043_small.jpg",
		"allow_buy_now": false,
		"has_report_link": false
	  },
	  {
		"row": 50,
		"diamond_id": 387604369,
		"item_type_id": 1,
		"status_id": 1,
		"shape_id": 3,
		"shape": "Round",
		"weight": 1.21,
		"color_short": "D",
		"clarity": "VVS1",
		"lab": "GIA",
		"grading_report_number": "7471490293",
		"cut_grade_short": "EX",
		"polish_short": "EX",
		"symmetry_short": "EX",
		"total_depth": 62.4,
		"table_width": 56,
		"fluorescence_short": "STG",
		"availability_short": "GA",
		"price_per_carat": 6059,
		"price_total": 7331.39,
		"img_preview_url": "https://idvm.s3.amazonaws.com/img/387604369_small.jpg",
		"allow_buy_now": true,
		"has_report_link": true
	  }
	]
  }
}
		

Generate JSON Request