dev.tsunagite.listSongs Documentation (EN)

main query

Batch song fetch

Parameters

cursor string Optional

Opaque string - receive from a previous request as the `cursor` value

game string at-uri Required

The game to find song records for.

limit integer Optional

How many records to return.

owner string at-identifier Optional

The handle or DID of the account to filter results to.

Output

Encodingapplication/json

cursor string Optional

Opaque string - pass back in a future request as the `cursor` value

songs array Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

cursor Opaque string - receive from a previous request as the `cursor` value

game * The game to find song records for.

limit How many records to return.

owner The handle or DID of the account to filter results to.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "songs"
      ],
      "properties": {
        "songs": {
          "type": "array",
          "items": {
            "ref": "dev.tsunagite.song",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string",
          "description": "Opaque string - pass back in a future request as the `cursor` value"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "game"
    ],
    "properties": {
      "game": {
        "type": "string",
        "format": "at-uri",
        "description": "The game to find song records for."
      },
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "description": "How many records to return."
      },
      "owner": {
        "type": "string",
        "format": "at-identifier",
        "description": "The handle or DID of the account to filter results to."
      },
      "cursor": {
        "type": "string",
        "description": "Opaque string - receive from a previous request as the `cursor` value"
      }
    }
  },
  "description": "Batch song fetch"
}