Skip to content
DIGIRAREDevelopers

Collection order book

GET
/v1/collections/{slug}/book
curl --request GET \
  --url https://api.digirare.com/v1/collections/example/book

Bounded collection trading workspace with ask depth, listing rows, exact-policy offer depth, individual offers, and recent fills. funded_slots counts distinct bid UTXOs within one level; shared slots may appear in multiple alternative policy levels and are never summed into cross-level capacity.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Bounded collection asks, policy demand, and fills

Media typeapplication/json
object
result
required
object
asks
required
Array<object>
object
price_sats
required
integer
>= 1 <= 9007199254740991
depth
required
integer
>= 1
listings
required
Array
object
id
required
string
asset
required

Canonical compact Counterparty key. A subasset uses its A ID; asset_longname is display metadata.

string
asset_longname
string | null
seller
required

Mainnet P2TR or P2WPKH address. The SIGNING capability: every signature is verified by reconstructing a BIP-143/BIP-341 witness sighash.

string
utxo_txid
required
string
/^[0-9a-f]{64}$/
utxo_vout
required
integer
quantity_raw
required
string
/^(0|[1-9][0-9]*)$/
price_sats
required
integer
>= 1 <= 9007199254740991
created_at
required
integer
protocol_subtype
string | null
media_kind
string | null
Allowed values: image animation video html svg
expires_at
required
integer | null
offer_levels
required
Array<object>
object
price_sats
required
integer
>= 1 <= 9007199254740991
funded_slots
required
integer
>= 1
scope
required
string
Allowed values: asset collection
kind
required
string
Allowed values: asset collection trait
asset
required
One of:

Canonical compact Counterparty key. A subasset uses its A ID; asset_longname is display metadata.

string
collection
required
string | null
max_supply_units
required
integer | null
min_supply_units
required
integer | null
issued_year
required
integer | null
series
required
integer | null
artist
required
string | null
offers
required
Array<object>
object
id
required
string
bidder
required

Mainnet P2TR or P2WPKH address. The SIGNING capability: every signature is verified by reconstructing a BIP-143/BIP-341 witness sighash.

string
bid_txid
required
string
/^[0-9a-f]{64}$/
bid_vout
required
integer
funding_slot_id
required
string
price_sats
required
integer
>= 1 <= 9007199254740991
scope
required
string
Allowed values: asset collection
kind
required
string
Allowed values: asset collection trait
asset
required
One of:

Canonical compact Counterparty key. A subasset uses its A ID; asset_longname is display metadata.

string
collection
required
string | null
max_supply_units
required
integer | null
min_supply_units
required
integer | null
issued_year
required
integer | null
series
required
integer | null
artist
required
string | null
expires_at
required
integer
created_at
required
integer
fills
required
Array<object>
object
txid
required
string
/^[0-9a-f]{64}$/
kind
required
string
ref_id
required
string
asset
required

Canonical compact Counterparty key. A subasset uses its A ID; asset_longname is display metadata.

string
asset_longname
string | null
seller
required

Mainnet P2TR or P2WPKH address. The SIGNING capability: every signature is verified by reconstructing a BIP-143/BIP-341 witness sighash.

string
buyer
required

Mainnet P2TR or P2WPKH address. The SIGNING capability: every signature is verified by reconstructing a BIP-143/BIP-341 witness sighash.

string
price_sats
required
integer
>= 1 <= 9007199254740991
platform_fee_sats
required
integer
delivery_mode
required
string
Allowed values: detached attached
broadcast_at
required
integer
confirmed_at
required
integer | null
block_index
required
integer | null
top_collection_offer_sats
required
One of:
integer
>= 1 <= 9007199254740991
best_offer_sats
required
One of:
integer
>= 1 <= 9007199254740991
listings_truncated
required
boolean
offer_levels_truncated
required
boolean
offers_truncated
required
boolean
Example
{
  "result": {
    "listings": [
      {
        "media_kind": "image"
      }
    ],
    "offer_levels": [
      {
        "scope": "asset",
        "kind": "asset"
      }
    ],
    "offers": [
      {
        "scope": "asset",
        "kind": "asset"
      }
    ],
    "fills": [
      {
        "delivery_mode": "detached"
      }
    ]
  }
}

404

Section titled “404”

Stable machine-readable failure

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: invalid_request unsupported_address_type unauthenticated forbidden not_found method_not_allowed state_changed expired invalid_transaction rate_limited internal_error upstream_unavailable service_unavailable checkout_changed target_unavailable signature_invalid template_mismatch mempool_rejected broadcast_unknown conflict_spend duplicate_funding_slot offer_selection_unavailable attached_delivery_single_item_only insufficient_funds insufficient_asset_balance price_below_minimum listing_price_above_maximum counter_price_invalid self_trade offer_capacity_full open_offer_limit policy_offer_refused
retryable
boolean
mempool_policy

On 422 mempool_rejected from a broadcast: which deterministic node policy refused the bytes. Retrying the same bytes fails the same way. fee_floor: re-quote at a higher fee_rate. chain_too_long: too many unconfirmed ancestors; wait for a confirmation, then retry. truc: a version-3 (TRUC) package rule, such as spending an unconfirmed version-3 output; wait for a confirmation, then retry.

string
Allowed values: fee_floor chain_too_long truc dust nonstandard
mempool_reason

The node’s own reject reason, on mempool_rejected (422) and on state_changed (409) when a broadcast lost to a conflicting or replacing spend.

string
wait_for_confirmation

Present and true when mempool_policy is chain_too_long or truc.

boolean
claims_released

On a checkout or accept completion refused as mempool_rejected: the journaled settlement ended and every listing, bid, and asset claim it held was released (its inputs were proven unspent). The quote or accept is replaced; request a new one.

boolean
refused_listings

Batch listing routes only: every refused item. The first sets the status and code.

Array<object>

One refused item in a batch refusal’s refused_listings array. Nothing in the batch was changed.

object
index
required
integer
listing_id
required
string
status
required
integer
code
required
string
error
required
string
key
additional properties
any
retry_after_seconds

On 429 rate_limited: the exact seconds until the oldest counted request leaves the window; a retry then is admitted (also sent as Retry-After). Limited writes are bucketed per route scope in exact sliding 60-second windows: by session address when a valid x-session-token is present, otherwise by IP, with a per-IP ceiling across sessions. Expensive writes: 20, ceiling 120. Signed completions: 120, ceiling 600. Session minting (/auth/*): 60 per IP. A request refused by any bucket is counted by none.

integer
>= 1
key
additional properties
any
Example
{
  "code": "invalid_request",
  "mempool_policy": "fee_floor"
}