app.rocksky.event.getEvents

rocksky.app

Documentation

List indexed music events, soonest first. Without a time window only unexpired events are returned: those ending (or, with no end, starting) today or later, plus undated ones.

main query

List indexed music events, soonest first. Without a time window only unexpired events are returned: those ending (or, with no end, starting) today or later, plus undated ones.

Parameters

artist string Optional

Only events this artist plays: the artist's AT-URI, id or sha256.

did string did Optional

Only events published by this repo.

from string datetime Optional

Only events that end at or after this time. Defaults to the start of today (UTC) when neither `to` nor `includePast` is given.

genre string Optional

Only events whose genre matches (case-insensitive).

includePast boolean Optional

Return past events too, most recent first, instead of upcoming ones.

kind string Optional

Only events of this kind (concert, festival...).

limit integer Optional

The maximum number of events to return.

offset integer Optional

The offset for pagination.

rsvpBy string did Optional

Only events this DID has RSVP'd to (going or interested).

to string datetime Optional

Only events that start at or before this time.

Output

Encodingapplication/json
events array Required

No description available.

Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Only events this artist plays: the artist's AT-URI, id or sha256.
Only events published by this repo.
Only events that end at or after this time. Defaults to the start of today (UTC) when neither `to` nor `includePast` is given.
Only events whose genre matches (case-insensitive).
Return past events too, most recent first, instead of upcoming ones.
Only events of this kind (concert, festival...).
The maximum number of events to return.
The offset for pagination.
Only events this DID has RSVP'd to (going or interested).
Only events that start at or before this time.
View raw schema 
{
  "description": "List indexed music events, soonest first. Without a time window only unexpired events are returned: those ending (or, with no end, starting) today or later, plus undated ones.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "events": {
          "items": {
            "ref": "app.rocksky.event.defs#eventView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "events"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "artist": {
        "description": "Only events this artist plays: the artist's AT-URI, id or sha256.",
        "type": "string"
      },
      "did": {
        "description": "Only events published by this repo.",
        "format": "did",
        "type": "string"
      },
      "from": {
        "description": "Only events that end at or after this time. Defaults to the start of today (UTC) when neither `to` nor `includePast` is given.",
        "format": "datetime",
        "type": "string"
      },
      "genre": {
        "description": "Only events whose genre matches (case-insensitive).",
        "type": "string"
      },
      "includePast": {
        "description": "Return past events too, most recent first, instead of upcoming ones.",
        "type": "boolean"
      },
      "kind": {
        "description": "Only events of this kind (concert, festival...).",
        "type": "string"
      },
      "limit": {
        "default": 20,
        "description": "The maximum number of events to return.",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "offset": {
        "default": 0,
        "description": "The offset for pagination.",
        "minimum": 0,
        "type": "integer"
      },
      "rsvpBy": {
        "description": "Only events this DID has RSVP'd to (going or interested).",
        "format": "did",
        "type": "string"
      },
      "to": {
        "description": "Only events that start at or before this time.",
        "format": "datetime",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@