GET /api/v1/locations/within_bounding_box(.:format)
Returns locations within transmitted bounding box

This sends locations within the sw_corner and ne_corner bounding box. It includes a list of machines at the location. If the bounding box diagonal exceeds 500 miles and no limit param and no_details != 2 is sent, results are capped at 50 and pagination metadata is included in the response.

Supported Formats

json, geojson

Params

Param name Description
swlat
required

SW_Latitude

Validations:

  • Must be a String
swlon
required

SW_Longitude

Validations:

  • Must be a String
nelat
required

NE_Latitude

Validations:

  • Must be a String
nelon
required

NE_Longitude

Validations:

  • Must be a String
by_type_id
optional

Location type ID to search by

Validations:

  • Must be a Integer
manufacturer
optional

Locations with machines from this manufacturer. Multiple manufacturers can be chained together like manufacturer[]=Stern&manufacturer[]=Bally etc.

Validations:

  • Must be a String
by_machine_id
optional

Machine ID to find in locations, returns all versions in group. Multiple IDs can be chained together like by_machine_id[]=111&by_machine_id[]=222 etc.

Validations:

  • Must be a Integer
by_machine_single_id
optional

Machine ID to find in locations, returns only exact version. Multiple IDs can be chained together like by_machine_single_id[]=111&by_machine_single_id[]=22.

Validations:

  • Must be a Integer
by_machine_group_id
optional

Machine Group ID to find in locations. Multiple IDs can be chained together like by_machine_group_id[]=111&by_machine_group_id[]=22.

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 any variant models of the machine. Multiple IDs can be chained together like by_machine_id_ic[]=111&by_machine_id_ic[]=22.

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. Multiple IDs can be chained together like by_machine_single_id_ic[]=111&by_machine_single_id_ic[]=22.

Validations:

  • Must be a Integer
by_machine_year
optional

Locations with at least one machine manufacturered in this year. Multiple years can be chained together by_machine_year[]=1980&by_machine_year[]=1982.

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_operator_id
optional

Operator ID to search by

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

Validations:

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

User ID of Faved Locations

Validations:

  • Must be a Integer
by_ipdb_id
optional

IPDB ID to find in locations. Multiple IDs can be chained together like by_ipdb_id[]=4565&by_ipdb_id[]=2345.

Validations:

  • Must be a Integer
by_opdb_id
optional

OPDB ID to find in locations. Multiple IDs can be chained together like by_opdb_id[]=4565&by_opdb_id[]=2345.

Validations:

  • Must be a Integer
by_at_least_n_machines
optional

Only locations with N or more machines

Validations:

  • Must be a Integer
by_at_least_n_machines_type
optional

Only locations with N or more machines

Validations:

  • Must be a Integer
by_machine_type
optional

Locations with machines of this type (em, ss, me). Multiple types can be chained together like by_machine_type[]=ss&by_machine_type[]=em.

Validations:

  • Must be a String
by_machine_display
optional

Locations with machines with this display (alphanumeric, lcd, dmd, reels, lights). Multiple display types can be chained together like by_machine_display[]=dmd&by_machine_display[]=reels.

Validations:

  • Must be a String
no_details
optional

Omit data that app does not need from pull (options include ‘1’ or ‘2’)

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.

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).

Validations:

  • Must be a String
limit
optional

Limit results to a quantity and include pagination metadata in response

Validations:

  • Must be a Integer
order_by
optional

Order results descending by a field in the locations scope. Allowed fields are updated_at, name, machine_count, distance. Otherwise, sorts by location ID. Using distance requires user_lat and user_lon params

Validations:

  • Must be a String
machines_only
optional

When set to ‘1’, returns only a flat list of unique machine_ids found across all matching locations. No location data is included.

Validations:

  • Must be a Integer