Catalog

Get one diamond

Returns a single loose diamond by its product id or by the grading report number (GCAL, IGI, or GIA), which is the identifier an agent usually has after reading a product page. A 404 means the stone has sold or the id is wrong; list current inventory with listDiamonds and pick again.

get/api/v1/diamonds/{id}

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/diamonds/{id}
  • Auth: one of:
    • none
    • API key in header X-Ada-Api-Key
    • OAuth 2 (authorization code, authorization URL https://www.adadiamonds.com/oauth/authorize, token URL https://www.adadiamonds.com/api/oauth/token; client credentials, token URL https://www.adadiamonds.com/api/oauth/token, scopes: catalog:read)

Path parameters

idstring required

Product id (from listDiamonds) or grading report number.

Response

The diamond.

object'diamond'

Present on single-item responses.

currency'USD'
idstring required
namestring required
urlstring uri required
pricenumber nullable required

USD, loose stone only.

caratnumber nullable
shapestring nullable
colorstring nullable
claritystring nullable
cutstring nullable
certificatestring nullable

Grading report number.

labstring nullable

Grading laboratory (GCAL, IGI, GIA).

measurementsstring nullable
lengthToWidthRationumber nullable

Example response

{
  "name": "1.02ct F VS1 Ideal Round"
}

Changes

No recorded changes to this operation across all 1 revision of this API.