Get a collection

GET

/v1/collections/{slug}

const url = 'https://api.digirare.com/v1/collections/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Parameters

Path Parameters

slug

required

string

>= 1 characters

Responses

200

Collection identity and market summary

application/json

object

result

required

object

slug

required

string

name

required

string

kind

required

string

Allowed values: canonical curated

art_frame

required

string

Allowed values: card square landscape

blurb

required

string | null

listable

required

integer

Allowed values: 0 1

sort_rank

required

integer

assets

required

integer

listed

required

integer

floor_sats

required

One of:

integer
null

integer

>= 1 <= 9007199254740991

volume_24h_sats

required

Gross satoshis filled; zero when nothing traded

integer

sales_24h

required

Filled items; a cart of three listings is three sales

integer

volume_7d_sats

required

Gross satoshis filled; zero when nothing traded

integer

sales_7d

required

Filled items; a cart of three listings is three sales

integer

volume_30d_sats

required

Gross satoshis filled; zero when nothing traded

integer

sales_30d

required

Filled items; a cart of three listings is three sales

integer

volume_all_sats

required

Gross satoshis filled; zero when nothing traded

integer

sales_all

required

Filled items; a cart of three listings is three sales

integer

first_issued_year

required

Issue year of the earliest member asset; null until one is known

integer | null

last_issued_year

required

Issue year of the latest member asset; null until one is known

integer | null

founded_year

required

Curated founding year from the registry; the era label starts here when present

integer | null

website_url

required

Official site from the registry’s links, https only

string | null

x_url

required

Official X account from the registry’s links, https only

string | null

offers

required

Distinct live funding slots (bid UTXOs and standing-offer fundings) behind the collection’s collection, trait, and member-asset offers

integer

holders

required

Distinct addresses holding a member asset, from the maintained holder projection; null until the balance index has bootstrapped

integer | null

Example

{
  "result": {
    "kind": "canonical",
    "art_frame": "card",
    "listable": 0
  }
}

404

Stable machine-readable failure

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