GET /api/v1/events.json
Fetch upcoming events at a location, or near a point

Pass location_id, or lat, lon, and radius. Sorted by start date. With location_id, returns at most 500 events, each with id, name, start_date, end_date, ifpa_tournament_id, external_link, event_type, ranking, long_desc. Otherwise returns 50 events per page, with a pagy object for paging (pass page to fetch more), each with id, ifpa_tournament_id, name, start_date, end_date, address, external_location_name, external_link, event_type, ranking, long_desc, location_id, and location_name, which is null unless the event is at a Pinball Map location.

Supported Formats

json

Params

Param name Description
location_id
optional

Location ID

Validations:

  • Must be a Integer
lat
optional

Latitude

Validations:

  • Must be a String
lon
optional

Longitude

Validations:

  • Must be a String
radius
optional

Search radius (max 250)

Validations:

  • Must be a Integer
distance_unit
optional

m (miles) or k (kilometers). Defaults to m

Validations:

  • Must be a String
start_date
optional

YYYY-MM-DD, the client’s local date, to hide events that already ended there. Must be within a day of the server’s date

Validations:

  • Must be a String
page
optional

Page number, for lat, lon, and radius searches. Defaults to 1

Validations:

  • Must be a Integer