/blur/collections/tokens

POST /api/blur/collections/tokens

Price: 5 credits

List the NFTs in a Blur collection (listed for sale by default)

How to use it

List the NFTs in a Blur collection, identified by its slug (e.g. 'azuki') or contract address. By default returns only tokens currently listed for sale (ordered by ask price); set listed_only to false to include unlisted tokens. Narrow the results by trait values, ask-price range (price_min/price_max in ETH) and rarity-rank range (rarity_rank_min/rarity_rank_max, where rank 1 is the rarest). Each token returns its token id, name, image, traits, rarity score and rank, current ask price, highest standing bid, last sale and last cost basis (each with amount, unit, listing time and marketplace), owner address, how many tokens that owner holds, and a suspicious flag.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• collection string required — Collection slug (e.g. 'azuki') or its on-chain contract address (examples: "azuki", "0xed5af388653567af2f388e6224dc7c4b3241c544"; minLength: 1)
• count integer required — Number of tokens to return (min: 1)
• listed_only boolean — Only return tokens currently listed for sale (default: true)
• traits object nullable — Filter to tokens matching the given trait values, keyed by trait name (e.g. {"Background": ["Dark Purple"], "Type": ["Human"]}) (examples: {"Background":["Dark Purple"]})
  • * array
• price_min number nullable — Only return tokens priced at or above this amount (min: 0)
• price_max number nullable — Only return tokens priced at or below this amount (min: 0)
• rarity_rank_min integer nullable — Only return tokens with rarity rank at or above this value (1 = rarest) (min: 1)
• rarity_rank_max integer nullable — Only return tokens with rarity rank at or below this value (1 = rarest) (min: 1)

Response

• @type string (default: "BlurToken")
• token_id string required
• name string nullable
• image string nullable
• traits object (default: {})
  • * string
• rarity_score number nullable
• rarity_rank integer nullable
• price object nullable
  • @type string (default: "BlurPrice")
  • amount number nullable
  • unit string nullable
  • listed_at string nullable
  • marketplace string nullable
• highest_bid object nullable
  • @type string (default: "BlurPrice")
  • amount number nullable
  • unit string nullable
  • listed_at string nullable
  • marketplace string nullable
• last_sale object nullable
  • @type string (default: "BlurPrice")
  • amount number nullable
  • unit string nullable
  • listed_at string nullable
  • marketplace string nullable
• last_cost_basis object nullable
  • @type string (default: "BlurPrice")
  • amount number nullable
  • unit string nullable
  • listed_at string nullable
  • marketplace string nullable
• owner object nullable
  • @type string (default: "BlurTrader")
  • address string required
  • username string nullable
• owner_owned_count integer nullable
• is_suspicious boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Collection not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.