Skip to content

Commit 6d1c97b

Browse files
committed
Add event RPC API index page
1 parent 36cd009 commit 6d1c97b

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

docs/rpc/event/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Event RPC
2+
3+
Methods for managing Bitcoin-related events shown on BTC Map. Most events are
4+
either conferences or recurring community meetups, pinned to a fixed location
5+
via `(lat, lon)` and optionally linked to an [area](../area-methods.md).
6+
7+
Each event has its own row in the `event` table. Deletion is soft (`deleted_at`
8+
is set); use `get_events` with `include_deleted` to surface tombstones, and
9+
`include_past` to surface events whose `starts_at` is already in the past.
10+
Events without a `starts_at` are treated as permanent and are always returned
11+
by `get_events`.
12+
13+
If the calling user has a non-empty
14+
[geofence](../user-methods.md#set_user_geofence), `create_event`,
15+
`update_event`, and `delete_event` enforce that the event falls inside the
16+
geofence (via `area_id` or via its `(lat, lon)`). This applies equally to
17+
root, admin, and event manager callers.
18+
19+
- [create_event](create_event.md) - Add a new event
20+
- [get_event](get_event.md) - Retrieve a single event by id
21+
- [get_events](get_events.md) - List events, with optional past/deleted filtering
22+
- [update_event](update_event.md) - Partially update an existing event
23+
- [delete_event](delete_event.md) - Soft-delete an event

0 commit comments

Comments
 (0)