bluesky.search
stable Standard
Search Bluesky users by keyword.
GET /v1/bluesky/search
What you get#
A list of Bluesky results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.
Pagination: 10 results per page. The response carries a pagination block; send its next_cursor back as the cursor parameter to get the next page. Every page is one call at the price below. See Pagination.
Also works with: Multi-platform search as the Bluesky search leg. Any batch can include it.
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 |
|---|---|---|---|---|---|
q | string | yes | (required) | Search query | max 200 chars; trimmed, repeated spaces collapsed |
cursor | string | no | - | Opaque cursor from a previous response's pagination.next_cursor. Omit for the first page. | - |
Request#
curl "https://api.onekey.dev/v1/bluesky/search?q=bluesky" \
-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.
{
"success": true,
"data": [
{
"author": {
"id": "did:plc:z72i7hdynmk6r22z27h6tvur",
"username": "bsky.app",
"displayName": "Bluesky",
"avatarUrl": "https://cdn.bsky.app/img/avatar/plain/did:plc:z72i7hdynmk6r22z27h6tvur/bafkreihwihm6kpd6zuwhhlro75p5qks5qtrcu55jp3gddbfjsieiv7wuka"
},
"content": {
"text": "official Bluesky account (check username👆)\n\nBugs, feature requests, feedback: support@bsky.app"
}
},
{
"author": {
"id": "did:plc:eon2iu7v3x2ukgxkqaf7e5np",
"username": "safety.bsky.app",
"displayName": "Bluesky Safety",
"avatarUrl": "https://cdn.bsky.app/img/avatar/plain/did:plc:eon2iu7v3x2ukgxkqaf7e5np/bafkreih7mgyv6dugcguewqnuev64i7jsljhtrr6olfadmxq2dasfb7woam"
},
"content": {
"text": "Sharing updates about trust and safety on Bluesky.\n\nThis account’s mentions are not actively monitored. To report a post or account, use the in-app reporting feature.\n\nCommunity Guidelines: https://bsky.social/about/support/community-guidelines"
}
}
],
"metadata": {
"platform": "bluesky",
"endpoint": "search",
"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 |
|---|---|---|
did | author.id | - |
handle | author.username | - |
displayName | author.displayName | - |
description | content.text | - |
avatar | author.avatarUrl | safeUrl |
Caching and freshness#
- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked
stale: truewhile 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 hour more (marked stale).
- A "not found" is remembered for 1 minute 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 | Unknown endpoint path. |
| 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).