Skip to main content
GET
/
products
/
orderbook
/
v2
Get live orderbook for a product
curl --request GET \
  --url https://api.collectpure.com/products/orderbook/v2 \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variants": [
      {
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantTitle": "<string>",
        "listings": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "price": 123,
            "quantity": 123,
            "spotPremium": 123,
            "spotPremiumDollar": 123,
            "premiumPercent": 123,
            "premiumDollar": 123,
            "type": "<string>",
            "expiresAt": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "offers": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "price": 123,
            "quantity": 123,
            "spotPremium": 123,
            "spotPremiumDollar": 123,
            "premiumPercent": 123,
            "premiumDollar": 123,
            "type": "<string>",
            "expiresAt": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>"
          }
        ]
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

id
string<uuid>
required

The UUID of the product to get the orderbook for

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

data
object
required