Skip to content

API Introduction

The DiamondTracker API is a REST API that uses HTTPS for secure communication. Endpoints follow REST conventions and return JSON responses.

Base URL: https://igi.diamondmatch.org/

Authentication

To generate an API key, click your user name in the top right corner of DiamondTracker and go to My Profile, or open this link.

You can assign an optional tag to each API key, which is useful when managing multiple integrations. The key automatically expires after the selected duration. Keys with a duration of No Limit do not expire automatically but can be manually revoked.

Send the API key on every request with the x-api-key header.

curl "https://igi.diamondmatch.org/v3/external/users" \
  -H "x-api-key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://igi.diamondmatch.org/v3/external/users",
    headers={"x-api-key": "YOUR_API_KEY"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://igi.diamondmatch.org/v3/external/users", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});

if (!response.ok) {
  throw new Error(`API request failed: ${response.status}`);
}

console.log(await response.json());

Note

Keep API keys private. Do not expose them in browser code, public repositories, mobile applications, or customer-visible logs.

Endpoint Documentation

The latest endpoint documentation is available in the API v3 OpenAPI docs.

Info

The latest API endpoints are under the v3 prefix. For API v2 documentation, see the API v2 OpenAPI docs.

Pagination

Most endpoints that return an array of items can and should be paginated. Use the page and size query parameters.

curl "https://igi.diamondmatch.org/v3/external/users?page=0&size=25" \
  -H "x-api-key: YOUR_API_KEY"

Inventory Customization

Spacecode lets users customize inventory fields to match their workflows. Almost every inventory field is a custom field.

Use the external/fields endpoints to:

  • create a custom field
  • delete a custom field
  • inspect configured fields
  • start the asynchronous process that makes a field unique

Warning

Adding mandatory or unique fields can fail if the existing inventory already violates those rules. It is safest to apply mandatory or unique constraints on an empty inventory.

See the API v3 OpenAPI docs for the full request and response schemas.

SmartBoard Quickstart

For a practical SmartBoard integration workflow covering API key authentication, RFID scan retrieval, and pick-to-light, see the SmartBoard Quickstart.