Skip to main content
GET
/
products
/
get-product-order-book
/
v1
Get the order book for a product
curl --request GET \
  --url https://api.collectpure.com/products/get-product-order-book/v1 \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "listings": [
      {
        "price": 123,
        "qty": 123,
        "spotPremium": 123,
        "spotPremiumDollar": 123,
        "isUsersOrder": true,
        "usersQty": 123
      }
    ],
    "offers": [
      {
        "price": 123,
        "qty": 123,
        "spotPremium": 123,
        "spotPremiumDollar": 123,
        "isUsersOrder": true,
        "usersQty": 123
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

productId
string<uuid>
required
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)$
variantId
string<uuid>
required
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