Skip to content
DIGIRAREDevelopers

Collection browse facets

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

Collection-wide counts behind the browse rail: series, supply bucket, and editorial trait values. Counts cover the whole collection, not the current filter intersection. Trait names appear only with two to forty distinct values; Artist, Series and Card are carried as columns and never as trait facets.

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

Collection-wide facet counts for the browse rail

Media typeapplication/json
object
result
required
object
years
required
Array<object>
object
year
required
integer
count
required
integer
>= 1
artists
required
Array<object>
object
artist
required
string
count
required
integer
>= 1
series
required
Array<object>
object
series
required
integer
count
required
integer
>= 1
supply
required
Array<object>
object
bucket
required

Fixed supply buckets in whole units: one = exactly 1, small = 2 to 100, mid = 101 to 500, large = over 500.

string
Allowed values: one small mid large
count
required
integer
>= 1
traits
required
Array<object>
object
name
required
string
values
required
Array<object>
object
value
required
string
count
required
integer
>= 1
Example
{
  "result": {
    "supply": [
      {
        "bucket": "one"
      }
    ]
  }
}

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"
}