Skip to Content
ELK Developers

GET /v1/catalogue

Products and pricing availability

Download .md
GET
/v1/catalogue

Lists products available to your account, including quantity rules and pricing availability. Requires ViewQuotes and an approved source IP. Use limit and after_id for pagination. No request body is required.

Authorization

ApiKey
headerAuthorizationBearer <token>

Send Authorization: Bearer over HTTPS. Each key is associated with an account and environment. Invalid, expired or revoked keys return 401.

Query Parameters

limit?integer

Maximum products per page, integer 1 through 200.

Range1 <= value <= 200
Default50
after_id?string

Exclusive product UUID cursor from next_after_id; omit on the first page.

Formatuuid
Length36 <= length <= 36

Header Parameters

X-Request-ID?string

Optional request tracing UUID. The server generates one if omitted.

Formatuuid
Length36 <= length <= 36

Response Body

Eligible product page; pricing availability is indicative capability only.

application/json
  1. response
records*array<>
Itemsitems <= 200
next_after_id*|

Exclusive cursor for the next page, null when no lookahead product exists.

Example Request
curl -X GET 'https://api.elkcrypto.com/sandbox/v1/catalogue'
Example Response
{  "records": [    {      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",      "instrument_id": "ed4d91c8-6cde-426b-9f6e-169d7d2e7cda",      "market_id": "6364d859-8e1b-477a-bacc-de8305a9292b",      "market": "string",      "base_asset_id": "c3ca87d0-093e-49e6-8aba-f30514247a7e",      "quote_asset_id": "d745226c-506e-4e9c-8294-a29de6cd3f8b",      "symbol": "string",      "enabled": true,      "broker_rules": {        "mode": "legacy_fixed",        "price_tick": "string",        "minimum_quantity": "string",        "quantity_step": "string"      },      "underlying_ids": [        "1542b493-ff3a-46ba-a3ef-56c5f15890ad"      ],      "offerings": [        {          "gateway_id": "string",          "provider": "string",          "offering_id": "string",          "revision": "string",          "rules": {            "instrument_id": "string",            "base_asset": "string",            "quote_asset": "string",            "kind": "SPOT",            "provider_instrument": "string",            "provider_stream_instrument": "string",            "rfq_supported": true,            "indicative_stream_supported": true,            "enabled": true,            "minimum_quantity": "string",            "maximum_quantity": "string",            "quantity_step": "string",            "price_tick": "string",            "price_significant_digits": 0          },          "present": true,          "available": true,          "last_seen_at_ms": 0,          "offering_source_observed_at_ms": 0,          "offering_inventory_mode": "reviewed_configuration",          "inventory_mode": "reviewed_configuration",          "source_observed_at_ms": 0,          "generated_at_ms": 0,          "expires_at_ms": 0        }      ],      "pricing_available": true    }  ],  "next_after_id": "62e3c65c-6389-4ce6-9a56-6f4bdc5adb1a"}