If you use this API for something cool, please let us know, we like looking at interesting uses of the data. If you have any suggestions/requests for endpoints, please email: scott.wainstock@gmail.com. If you have any patches that you'd like to submit to the API, please check out: github.com/scottwainstock/pbm.

Resources

Events

Resource Description
GET /api/v1/region/:region/events.json Get all events for a single region

Location machine xrefs

Resource Description
GET /api/v1/region/:region/location_machine_xrefs.json Get all machines at locations in a single region
GET /api/v1/region/:region/location_machine_xrefs/:id.json Get info about a single lmx
POST /api/v1/location_machine_xrefs.json Find or create a machine at a location
PUT /api/v1/location_machine_xrefs/:id.json Update a machine's condition at a location
DESTROY /api/v1/location_machine_xrefs/:id.json Remove a machine from a location

Location types

Resource Description
GET /api/v1/location_types.json Fetch all location types

Locations

Resource Description
POST /api/v1/locations/suggest.json Suggest a new location to add to the map
GET /api/v1/region/:region/locations.json Fetch locations for a single region
PUT /api/v1/locations/:id.json Update attributes on a location
GET /api/v1/locations/closest_by_lat_lon.json Returns the closest location to transmitted lat/lon
GET /api/v1/locations/:id/machine_details.json Display the details of the machines at this location
PUT /api/v1/locations/:id/confirm.json Confirm location information

Machine score xrefs

Resource Description
GET /api/v1/region/:region/machine_score_xrefs.json Fetch all high scores for a region
POST /api/v1/machine_score_xrefs.json Enter a new high score for a machine
GET /api/v1/machine_score_xrefs/:id.json View all high scores for a location's machine

Machines

Resource Description
GET /api/v1/machines.json Fetch all machines
POST /api/v1/machines.json Create a new canonical machine

Operators

Resource Description
GET /api/v1/region/:region/operators.json Fetch all operators
GET /api/v1/operators/:id.json Fetch information for a single operator

Region link xrefs

Resource Description
GET /api/v1/region/:region/region_link_xrefs.json Fetch all region-centric web sites

Regions

Resource Description
GET /api/v1/regions/does_region_exist.json Find if name corresponds to a known region
GET /api/v1/regions/closest_by_lat_lon.json Find closest region based on lat/lon
GET /api/v1/regions.json Fetch all regions
GET /api/v1/regions/:id.json Fetch information for a single region
POST /api/v1/regions/suggest.json Suggest a new region to add to the map
POST /api/v1/regions/contact.json Contact regional administrator
POST /api/v1/regions/app_comment.json Send comments about the app

User submissions

Resource Description
GET /api/v1/region/:region/user_submissions.json Fetch user submissions for a single region

Users

Resource Description
GET /api/v1/users/auth_details.json Fetch auth info for a user
POST /api/v1/users/signup.json Signup a new user
GET /api/v1/users/:id/profile_info.json Fetch profile info for a user

Zones

Resource Description
GET /api/v1/region/:region/zones.json Fetch zones for a single region