bluesky.list

stable Standard

A Bluesky list's metadata.

GET /v1/bluesky/list

What you get#

One Bluesky record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`list`	string	yes	(required)	List AT URI	max 255 chars; must match `at://[A-Za-z0-9:._-]{3,100}/[A-Za-z.]{3,60}/[A-Za-z0-9._~-]{1,64}`; trimmed

Request#

curl "https://api.onekey.dev/v1/bluesky/list?list=at%3A%2F%2Fdid%3Aplc%3Az72i7hdynmk6r22z27h6tvur%2Fapp.bsky.graph.list%2F3lvpca43j5z26" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Bluesky response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "content": {
      "id": "at://did:plc:z72i7hdynmk6r22z27h6tvur/app.bsky.graph.list/3lvpca43j5z26",
      "title": "Community Showcase",
      "text": "Community projects built on the Bluesky API ✨",
      "language": "app.bsky.graph.defs#curatelist"
    },
    "author": {
      "id": "did:plc:z72i7hdynmk6r22z27h6tvur",
      "username": "bsky.app"
    },
    "engagement": {
      "likes": 21
    }
  },
  "metadata": {
    "platform": "bluesky",
    "endpoint": "list",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`list.uri`	`content.id`	-
`list.name`	`content.title`	-
`list.description`	`content.text`	-
`list.creator.did`	`author.id`	-
`list.creator.handle`	`author.username`	-
`list.listItemCount`	`engagement.likes`	`toNumber`
`list.purpose`	`content.language`	-

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).