get businesses near you

GET /api/businesses

Api key auth

Businesses API

Use this API to access businesses nearby you, based on latitude and longitude you provide.

Params

1. Lat

Latitude of the location of the user (string value)
Required

2. Long

Longitude of the location of the user (string value)
Required

3. range

Range of the result
You can specify the range in kilometers
default is the area of radius .5kms to 2kms
optional

4. page

This API is paginated.
default page number is 1
optional

5. perPage

per page results
default is 10
max is 100
minimum is 10
optional

Query parameters

lat string Required

string value of latitude

Default value is 23983.2.
long string Required

string value of longitude

Default value is -29829.09.
range string

specify range of results
page string

page number
perPage integer

number of results per page

Minimum value is 10, maximum value is 100.

Responses

200

OK
Hide response attributes Show response attributes object
- address string
- attributes object
  
  Hide attributes attribute Show attributes attribute object
  
  Additional properties are allowed
- business_id string
- categories string
- city string
- geoHash string
- hours object
  
  Hide hours attribute Show hours attribute object
  
  Additional properties are allowed
- is_open integer
- latitude number
- longitude number
- name string
- postal_code string
- review_count integer
- stars number
- state string
- userID integer
400

Bad Request
Hide response attributes Show response attributes object
- message string
- status string
- status_code integer
412

Precondition Failed
Hide response attributes Show response attributes object
- message string
- status string
- status_code integer
500

Internal Server Error
Hide response attributes Show response attributes object
- message string
- status string
- status_code integer

GET /api/businesses

curl \
 -X GET http://api.example.com/api/businesses?lat=23983.2&long=-29829.09 \
 -H "Authorization: $API_KEY"

Response examples (200)

{
  "address": "string",
  "attributes": {},
  "business_id": "string",
  "categories": "string",
  "city": "string",
  "geoHash": "string",
  "hours": {},
  "is_open": 42,
  "latitude": 42.0,
  "longitude": 42.0,
  "name": "string",
  "postal_code": "string",
  "review_count": 42,
  "stars": 42.0,
  "state": "string",
  "userID": 42
}

Response examples (200)

{
  "address": "string",
  "attributes": {},
  "business_id": "string",
  "categories": "string",
  "city": "string",
  "geoHash": "string",
  "hours": {},
  "is_open": 42,
  "latitude": 42.0,
  "longitude": 42.0,
  "name": "string",
  "postal_code": "string",
  "review_count": 42,
  "stars": 42.0,
  "state": "string",
  "userID": 42
}

Response examples (400)

{
  "message": "internal server error",
  "status": "error",
  "status_code": 500
}

Response examples (400)

{
  "message": "internal server error",
  "status": "error",
  "status_code": 500
}

Response examples (412)

{
  "message": "internal server error",
  "status": "error",
  "status_code": 500
}

Response examples (412)

{
  "message": "internal server error",
  "status": "error",
  "status_code": 500
}

Response examples (500)

{
  "message": "internal server error",
  "status": "error",
  "status_code": 500
}

Response examples (500)

{
  "message": "internal server error",
  "status": "error",
  "status_code": 500
}