GET /api/v1/locations.json
Fetch locations for all regions

GET /api/v1/region/:region/locations.json
Fetch locations for a single region

This will also return a list of machines at each location

Supported Formats

json

Params

Param name Description
region
required

Name of the Region you want to see locations for

Validations:

  • Must be a String
by_location_name
optional

Name of location to search for

Validations:

  • Must be a String
by_location_id
optional

Location ID to search for

Validations:

  • Must be a Integer
by_machine_id
optional

Machine ID to find in locations. Returns locations with all variant models of the machine

Validations:

  • Must be a Integer
by_machine_single_id
optional

Machine ID to find in locations, returns only exact version

Validations:

  • Must be a Integer
by_machine_group_id
optional

Machine Group to search for

Validations:

  • Must be a String
by_machine_id_ic
optional

Machine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with all variant models of the machine.

Validations:

  • Must be a Integer
by_machine_single_id_ic
optional

Machine ID to find in locations, when Stern Insider Connected is enabled for that machine at that location. Returns locations with exact model of the machine.

Validations:

  • Must be a Integer
manufacturer
optional

Locations with machines from this manufacturer. Additional filtering required for this endpoint.

Validations:

  • Must be a String
by_machine_year
optional

Locations with at least one machine manufacturered in this year. Additional filtering required for this endpoint.

Validations:

  • Must be a Integer
by_machine_year_gte
optional

Locations with at least one machine manufactured in this year or later

Validations:

  • Must be a Integer
by_machine_year_lte
optional

Locations with at least one machine manufactured in this year or earlier

Validations:

  • Must be a Integer
by_ipdb_id
optional

IPDB ID to find in locations

Validations:

  • Must be a Integer
by_opdb_id
optional

OPDB ID to find in locations

Validations:

  • Must be a Integer
by_machine_name
optional

Find machine name in locations

Validations:

  • Must be a String
by_city_id
optional

City to search for

Validations:

  • Must be a String
by_city_no_state
optional

City to search for when that city is in a country that does not have state/provinces in the data

Validations:

  • Must be a String
by_state_id
optional

State to search for. Matches location state field (often an abbreviation). Additional filtering required for this endpoint.

Validations:

  • Must be a String
by_country
optional

Country to search for. Matches location country code, in all caps, such as ‘US’. Additional filtering required for this endpoint.

Validations:

  • Must be a String
by_zone_id
optional

Zone ID to search by

Validations:

  • Must be a Integer
by_operator_id
optional

Operator ID to search by

Validations:

  • Must be a Integer
by_type_id
optional

Location type ID to search by

Validations:

  • Must be a Integer
place_id
optional

Google Maps Place ID for helping app to identify whether location exists

Validations:

  • Must be a String
by_at_least_n_machines
optional

Only locations with N or more machines. Additional filtering required for this endpoint.

Validations:

  • Must be a Integer
by_at_least_n_machines_type
optional

Only locations with N or more machines. Additional filtering required for this endpoint.

Validations:

  • Must be a Integer
by_is_stern_army
optional

Send only locations labeled as Stern Army

Validations:

  • Must be a Integer
by_ic_active
optional

Send only locations that have at least one machine that is tagged as Stern Insider Connected. Additional filtering required for this endpoint.

Validations:

  • Must be one of: true, false, 1, 0.
by_machine_type
optional

Locations with machines of this type (em, ss, me). Additional filtering required for this endpoint.

Validations:

  • Must be a String
by_machine_display
optional

Locations with machines with this display (alphanumeric, lcd, dmd, reels, lights). Additional filtering required for this endpoint.

Validations:

  • Must be a String
no_details
optional

Omit lmx/condition data from pull. Additional filtering required for this endpoint.

Validations:

  • Must be a Integer
with_lmx
optional

Include location machine details such as comments. Additional filtering required for this endpoint.

Validations:

  • Must be a Integer
regionless_only
optional

Show only regionless locations

Validations:

  • Must be a Integer
by_all_ages
optional

Send only all ages locations. Locations tagged ‘Yes’ or ‘At Times’ are both included. ‘No’ for not all ages. Additional filtering required for this endpoint.

Validations:

  • Must be a String
by_payment_type
optional

Send only free play locations. Accepted values are ‘Free Play’ and ‘No’ (meaning not Free Play). Additional filtering required for this endpoint.

Validations:

  • Must be a String