# Real-Time Local & Maps Data API

> Complete reference documentation for the OpenWeb Ninja Real-Time Local & Maps Data API. Includes code examples, data samples, and usage guides for searching and enriching businesses and places, tracking local rankings, finding local events, and getting reviews, photos, geocoding, directions, and events from Google Maps & Waze, Yelp in Real-Time.

## Overview

Complete reference documentation for the OpenWeb Ninja Real-Time Local & Maps Data API. Includes code examples, data samples, and usage guides for searching and enriching businesses and places, tracking local rankings, finding local events, and getting reviews, photos, geocoding, directions, and events from Google Maps & Waze, Yelp in Real-Time.

This API exposes 29 REST endpoints (Search, Search In Area, Area Search (Bounding Box), Area Search (Radius), Search Nearby, Business Details, Business Details Plus, Business Reviews, Business Review Details, Business Photos, Business Photo Details, Buisness Posts, Reverse Geocoding, Autocomplete, Business Search, Business Details, Business Reviews, Search Business Locations, Keyword Search at Coordinate Point, Calculate Grid Coordinate Points, Ranking at Coordinate Point, Full Grid Search, Alerts and Jams, Autocomplete, Driving Directions, Venues, Get Directions, Search Events, Event Details), returning structured JSON. See the endpoints below for parameters and full URLs.

Need help integrating? Contact support@openwebninja.com.
For high volume / large scale plans, please contact support@openwebninja.com.

## Endpoints

### GET /local-business-data/search - Search
Search local businesses on Google Maps with an option to pull emails and social profile links from their website (see the `extract_emails_and_contacts` parameter below).
Parameters:
- **query** (string, required, e.g. `Hotels in San Francisco, USA`): Search query / keyword **Examples:** `Plumbers near New-York, USA` `Bars in 94102, USA`
- limit (integer, default: `20`): Maximum number of businesses to return. **Allowed values:** `1-500`
- lat (string, default: `37.359428`): Latitude of the coordinates point from which the query is applied - recommended to use so that results are biased towards this location. Defaults to some central location in the region (see the region parameter).
- lng (string, default: `-121.925337`): Longitude of the coordinates point from which the query is applied - recommended to use so that results are biased towards this location. Defaults to some central location in the region (see the region parameter).
- zoom (string, default: `13`): Zoom level on which to make the search (the viewport is determined by lat, lng and zoom).
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- subtypes (string, e.g. `Plumber,Carpenter,Electrician`): Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. **Examples:** `Plumber,Carpenter,Electrician` `Night club,Dance club,Bar,Pub`
- verified (boolean): Only return verified businesses
- business_status (string, e.g. `OPEN`): Find businesses with specific status, specified as a comma separated list of the following values: `OPEN, CLOSED_TEMPORARILY, CLOSED` **Examples:** `OPEN` `CLOSED_TEMPORARILY,CLOSED`
- extract_emails_and_contacts (boolean, default: `false`): Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit.
- fields (string, e.g. `business_id,type,phone_number,full_address`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/search`

### POST /local-business-data/search - Bulk Search
Search multiple queries in a single request (up to 20 queries).
Parameters:
- **queries** (array of string, required, e.g. `["plumber in texas","coffee shop in san francisco","hotels in new york"]`): List of search queries to run in a single request (each treated like a normal Search query). Up to 20 queries per request.
- language (string, default: `en`): Set the language of the results (ISO 639-1 code).
- region (string, default: `us`): Query Google Maps from a particular region / country (ISO 3166-1 alpha-2 code).
- coordinates (string, e.g. `40.685219,-74.081180`): Bias the search toward a specific location, as a "lat,lng" string.
- limit (integer, default: `20`): Maximum number of businesses to return per query. Allowed values: 1-500.
- offset (integer, default: `0`): Number of businesses to skip per query, for pagination. Allowed values: 0-500.
- zoom (integer, default: `13`): Map zoom level used for each query (higher = tighter area). Allowed values: 0-22.
- dedup (boolean, default: `true`): If true, deduplicate overlapping businesses across queries.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/search`

### GET /local-business-data/search-in-area - Search In Area
Search businesses in a specific geographic area defined by a center coordinate point and zoom level.
Parameters:
- **query** (string, required, e.g. `pizza`): Search query / keyword
- **lat** (string, required, default: `37.359428`): Latitude of the center coordinate point of the area to search in.
- **lng** (string, required, default: `-121.925337`): Longitude of the center coordinate point of the area to search in.
- **zoom** (string, required, e.g. `13`): Zoom level on which to make the search (the search area / viewport is determined by lat, lng and zoom on a 1000x1000 screen)
- limit (string, default: `20`): Maximum number of businesses to return. **Allowed values:** `1-500`
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- subtypes (string, e.g. `Plumber,Carpenter,Electrician`): Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. **Examples:** `Plumber,Carpenter,Electrician` `Night club,Dance club,Bar,Pub`
- extract_emails_and_contacts (boolean, default: `false`): Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit.
- fields (string, e.g. `business_id,type,phone_number,full_address`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/search-in-area`

### GET /local-business-data/area-search-by-bounding-box - Area Search (Bounding Box)
Search businesses within a rectangular area defined by its bottom-left (south-west) and top-right (north-east) corner coordinates.
Parameters:
- **query** (string, required, e.g. `pizza`): Search query / keyword
- **bottom_left** (string, required, e.g. `40.606540,-74.013580`): The bottom-left (south-west) corner of the bounding box to search in, as a "lat,lng" string.
- **top_right** (string, required, e.g. `40.812151,-73.910522`): The top-right (north-east) corner of the bounding box to search in, as a "lat,lng" string.
- limit (string, default: `20`): Maximum number of businesses to return. **Allowed values:** `1-500`
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- subtypes (string, e.g. `Plumber,Carpenter,Electrician`): Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. **Examples:** `Plumber,Carpenter,Electrician` `Night club,Dance club,Bar,Pub`
- extract_emails_and_contacts (boolean, default: `false`): Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit.
- fields (string, e.g. `business_id,type,phone_number,full_address`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/area-search-by-bounding-box`

### GET /local-business-data/area-search-by-radius - Area Search (Radius)
Search businesses within a circular area defined by a center coordinate point (lat, lng) and a radius in meters.
Parameters:
- **query** (string, required, e.g. `pizza`): Search query / keyword
- **lat** (string, required, default: `37.359428`): Latitude of the center coordinate point of the area to search in.
- **lng** (string, required, default: `-121.925337`): Longitude of the center coordinate point of the area to search in.
- **radius** (string, required, e.g. `5000`): The radius (in meters) of the circular search area around the center coordinate point (lat, lng). Allowed values: 1-50000.
- limit (string, default: `20`): Maximum number of businesses to return. **Allowed values:** `1-500`
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- subtypes (string, e.g. `Plumber,Carpenter,Electrician`): Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. **Examples:** `Plumber,Carpenter,Electrician` `Night club,Dance club,Bar,Pub`
- extract_emails_and_contacts (boolean, default: `false`): Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. **Note:** in case `true`, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit.
- fields (string, e.g. `business_id,type,phone_number,full_address`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/area-search-by-radius`

### GET /local-business-data/search-nearby - Search Nearby
Search businesses near by specific geographic coordinates.
Parameters:
- **query** (string, required, e.g. `plumbers`): Search query / keyword **Examples:** `Bars and pubs` `Plumbers`
- **lat** (string, required, default: `37.359428`): Latitude of the geographic coordinates to search near by.
- **lng** (string, required, default: `-121.925337`): Longitude of the geographic coordinates to search near by.
- limit (string, default: `20`): Maximum number of businesses to return. **Allowed values:** `1-500`
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- subtypes (string, e.g. `Plumber,Carpenter,Electrician`): Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see *https://daltonluka.com/blog/google-my-business-categories*. **Examples:** `Plumber,Carpenter,Electrician` `Night club,Dance club,Bar,Pub`
- extract_emails_and_contacts (boolean, default: `false`): Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. **Note:** in case true, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit.
- fields (string, e.g. `business_id,type,phone_number,full_address`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/search-nearby`

### GET /local-business-data/business-details - Business Details
Get full business details including emails and social contacts.
Parameters:
- **business_id** (string, required, e.g. `0x880fd393d427a591:0x8cba02d713a995ed`): Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. **Examples:** `0x880fd393d427a591:0x8cba02d713a995ed` `ChIJkaUn1JPTD4gR7ZWpE9cCuow` In addition, batching of up to 20 Business Ids is supported in a single request using a comma separated list *(e.g. business_id=id1,id2)*.
- extract_emails_and_contacts (boolean, default: `true`): Whether to extract emails, contacts and social profiles for the business. In case true, businesses will be enriched with a emails_and_contacts field, potentially containing emails, phones, Facebook, LinkedIn, Instagram and other social profiles.
- extract_share_link (boolean, default: `false`): Whether to extract place's share link for the business. In case true, businesses will be enriched with a share_link field containing a shortened Google URL for sharing *(e.g. https://goo.gl/maps/oxndE8SVaNU5CV6p6)*.
- fields (string, e.g. `business_id,type,phone_number,full_address`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- language (string, default: `eu`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
- coordinates (string, e.g. `37.09024,-95.712891`): Geographic coordinates of the location from which the query is applied - recommended to use so that results are biased towards this location. Defaults to some central location in the region (see the region parameter).
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/business-details`

### GET /local-business-data/business-details-plus - Business Details Plus
Get full business details PLUS additional AI-powered enrichments — currently includes `keywords_mentioned_in_reviews`, an array of the keywords most frequently surfaced in the business' Google Maps reviews together with how many reviews mention each.
Parameters:
- **business_id** (string, required, e.g. `0x880fd393d427a591:0x8cba02d713a995ed`): Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. **Examples:** `0x880fd393d427a591:0x8cba02d713a995ed` `ChIJkaUn1JPTD4gR7ZWpE9cCuow` In addition, batching of up to 20 Business Ids is supported in a single request using a comma separated list *(e.g. business_id=id1,id2)*.
- extract_emails_and_contacts (boolean, default: `true`): Whether to extract emails, contacts and social profiles for the business. In case true, businesses will be enriched with an emails_and_contacts field, potentially containing emails, phones, Facebook, LinkedIn, Instagram and other social profiles.
- extract_share_link (boolean, default: `false`): Whether to extract place's share link for the business. In case true, businesses will be enriched with a share_link field containing a shortened Google URL for sharing.
- fields (string, e.g. `business_id,type,phone_number,full_address,keywords_mentioned_in_reviews`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
- coordinates (string, e.g. `37.09024,-95.712891`): Geographic coordinates of the location from which the query is applied - recommended to use so that results are biased towards this location. Defaults to some central location in the region (see the region parameter).
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/business-details-plus`

### GET /local-business-data/business-reviews-v2 - Business Reviews
Get all / paginate business reviews by Business Id using a pagination cursor.
Parameters:
- **business_id** (string, required, e.g. `0x89c259b5a9bd152b:0x31453e62a3be9f76`): Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. **Examples:** `0x880fd393d427a591:0x8cba02d713a995ed` `ChIJkaUn1JPTD4gR7ZWpE9cCuow`
- limit (string, default: `20`): Maximum number of business reviews to return. **Allowed values:** `1-100`
- cursor (string): Pagination cursor for fetching the next page of reviews. Pass the `cursor` value returned in the previous response's `data.cursor`. Omit on the first request to start from the most relevant reviews.
- translate_reviews (boolean): Whether to translate reviews to the language specified as the language parameter (defaults to false).
- query (string): Return reviews matching a text query
- sort_by (string, default: `most_relevant`, allowed: most_relevant | newest | highest_ranking | lowest_ranking): How to sort the reviews in the results.
- fields (string, e.g. `review_id,review_text,rating`): A comma separated list of review fields to include in the response (field projection). By default all fields are returned.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/business-reviews-v2`

### GET /local-business-data/review-details - Business Review Details
Get the details of a specific review by Google Id / Business Id or Google Place Id and Review Author Id.
Parameters:
- **business_id** (string, required, e.g. `0x89c259b5a9bd152b:0x31453e62a3be9f76`): The Business Id of the business for which the review belongs. Accepts `google_id` / `business_id` or `place_id`. **Examples:** `0x880fd393d427a591:0x8cba02d713a995ed` `ChIJkaUn1JPTD4gR7ZWpE9cCuow`
- **review_author_id** (string, required, e.g. `110228754725692228062`): Review author id (i.e review `author_id` field). In addition, batching of up to 20 Review Author Ids is supported in a single request using a comma separated list *(e.g.review_author_id=id1,id2)*.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/review-details`

### GET /local-business-data/business-photos - Business Photos
Get business photos by Business Id.
Parameters:
- **business_id** (string, required, e.g. `0x89c259b5a9bd152b:0x31453e62a3be9f76`): Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. **Examples:** `0x880fd393d427a591:0x8cba02d713a995ed` `ChIJkaUn1JPTD4gR7ZWpE9cCuow`
- limit (string, default: `20`): Maximum number of business photos to return. **Allowed values:** `1-100`
- cursor (string): Specify the cursor obtained from the previous request to get the next of result page (use for pagination).
- is_video (boolean, default: `false`): Only return video type media (type=video) or not.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- fields (string, e.g. `type,photo_url`): A comma separated list of review fields to include in the response (field projection). By default all fields are returned.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/business-photos`

### GET /local-business-data/photo-details - Business Photo Details
Get extra details about a business photo - caption, owner name and avatar, and more information.
Parameters:
- **business_id** (string, required, e.g. `0x89c259b5a9bd152b:0x31453e62a3be9f76`): The Business Id of the business for which the photo belongs. Accepts `google_id` / `business_id` or `place_id`. **Examples:** `0x880fd393d427a591:0x8cba02d713a995ed` `ChIJkaUn1JPTD4gR7ZWpE9cCuow`
- **photo_id** (string, required, e.g. `AF1QipMPYCqZ5Fe8a7Jc51KT9pWOS5c6tOKY_xvkCl23`): Photo Id of the photo to fetch. In addition, batching of up to 20 Photo Ids is supported in a single request using a comma separated list *(e.g. photo_id=id1,id2)*.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/photo-details`

### GET /local-business-data/business-posts - Buisness Posts
Get all / paginate Business Owner Posts ("From the owner" section on Google Maps) by Business Id, sorted chronologically.
Parameters:
- **business_id** (string, required, e.g. `0x880fd393d427a591:0x8cba02d713a995ed`): Unique Business Id. Accepts `google_id` / `business_id` or `place_id`. **Examples:** `0x880fd393d427a591:0x8cba02d713a995ed` `ChIJkaUn1JPTD4gR7ZWpE9cCuow`
- cursor (string): Specify the cursor obtained from the previous request to get the next of result page (use for pagination).
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes*.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/business-posts`

### GET /local-business-data/reverse-geocoding - Reverse Geocoding
Get the details of a place or address in a specific geographic location by latitude and longitude (reverse geocoding).
Parameters:
- **lat** (string, required, default: `40.6958453`): Latitude of the geographic coordinates to search near by.
- **lng** (string, required, default: `-73.9799119`): Longitude of the geographic coordinates to search near by.
- region (string, default: `us`): Query Google Maps from a particular region or country. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*.
- fields (string, e.g. `business_id,type,phone_number,full_address`): A comma separated list of business fields to include in the response (field projection). By default all fields are returned.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/reverse-geocoding`

### GET /local-business-data/autocomplete - Autocomplete
Returns place/address, business and query predictions for text-based geographic queries.
Parameters:
- **query** (string, required, e.g. `new y`): Search query
- region (string, default: `us`): Return results based to a particular region. For a list of supported region/country codes see *https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code)*.
- language (string, default: `en`): Set the language of the results. For a list of supported language codes see *https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2*.
- coordinates (string, e.g. `37.381315,-122.046148`): Geographic coordinates of the location from which the query is applied - recommended to use so that results are biased towards this location. Defaults to some central location in the region (see the region parameter).
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-business-data/autocomplete`

### GET /yelp/business-search - Business Search
Search for Yelp businesses by query / keyword and location.
Parameters:
- **query** (string, required): Search query / keyword
- **location** (string, required): Search location.
- sort_by (string, default: `RECOMMENDED`, allowed: RECOMMENDED | HIGHEST_RATED | REVIEW_COUNT): Return the results in a specific sort order.
- start (integer, default: `0`): Number of results to skip. Mainly used for pagination.
- price_range (string): Find business with specific price ranges, specified as a comma delimited list of the following values: $, $$, $$$, $$$$.
- yelp_domain (string, default: `yelp.com`, allowed: yelp.com | yelp.com.au | yelp.co.nz | ms.yelp.my | yelp.cz | yelp.dk | yelp.de | yelp.at | de.yelp.ch | en.yelp.be | yelp.ca | en.yelp.com.hk | en.yelp.my | en.yelp.com.ph | yelp.ie | yelp.com.sg | en.yelp.ch | yelp.co.uk | yelp.com.ar | yelp.cl | yelp.es | yelp.com.mx | fil.yelp.com.ph | yelp.fr | fr.yelp.ca | fr.yelp.ch | fr.yelp.be | yelp.no | yelp.pl | yelp.pot | yelp.com.br | fi.yelp.fi | sv.yelp.fi | yelp.se | yelp.com.tr | yelp.co.jp | zh.yelp.com.hk | yelp.com.tw): The yelp domain to use for the search.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/yelp/business-search`

### GET /yelp/business-details - Business Details
Fetch a single or multiple business details from Yelp.
Parameters:
- **business_id** (string, required): Yelp business id or alias to fetch details for. In addition, batching of up to 20 Business Ids or aliases is supported in a single request using a comma separated list (e.g. business_id=id1,id2).
- yelp_domain (string, default: `yelp.com`, allowed: yelp.com | yelp.com.au | yelp.co.nz | ms.yelp.my | yelp.cz | yelp.dk | yelp.de | yelp.at | de.yelp.ch | en.yelp.be | yelp.ca | en.yelp.com.hk | en.yelp.my | en.yelp.com.ph | yelp.ie | yelp.com.sg | en.yelp.ch | yelp.co.uk | yelp.com.ar | yelp.cl | yelp.es | yelp.com.mx | fil.yelp.com.ph | yelp.fr | fr.yelp.ca | fr.yelp.ch | fr.yelp.be | yelp.no | yelp.pl | yelp.pot | yelp.com.br | fi.yelp.fi | sv.yelp.fi | yelp.se | yelp.com.tr | yelp.co.jp | zh.yelp.com.hk | yelp.com.tw): The yelp domain to use for the search.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/yelp/business-details`

### GET /yelp/business-reviews - Business Reviews
Fetch a single or multiple business review pages from Yelp (each page includes up to 10 reviews).
Parameters:
- **business_id** (string, required): Yelp business id or alias to fetch reviews for.
- page (integer, default: `1`): Page to return (each page includes up to 10 results).
- page_size (integer, default: `10`): Results page size. Allowed values: 1-45.
- num_pages (integer, default: `1`): Number of pages to return, starting from page. Allowed values: 1-10. **Note:** requests for more than one page are charged 2x.
- sort (string, default: `BEST_MATCH`, allowed: BEST_MATCH | NEWEST | OLDEST | HIGHEST_RATED | LOWEST_RATED | ELITES): How to sort reviews in the results. Note that the ELITES value will cause the API to only return reviews posted by elite members.
- query (string): Return reviews matching a text query
- language (string, default: `en`): Only return reviews of a certain language. For a list of supported language codes see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/yelp/business-reviews`

### GET /local-rank-tracker/places - Search Business Locations
Returns a list of found Google My Business locations based on search query, including Service Area Businesses (SAB).
Parameters:
- **query** (string, required): Search query.
- near (string, e.g. `California, USA`): Narrow down your search results by using a city, state, country or any other free-form location string.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-rank-tracker/places`

### GET /local-rank-tracker/search - Keyword Search at Coordinate Point
Get search results at the specified coordinate point without any rank comparison data.
Parameters:
- **query** (string, required): Search query / keyword.
- **lat** (number, required, default: `37.341759`): Coordinate point latitude value.
- **lng** (number, required, default: `-121.938314`): Coordinate point longitude value.
- zoom (number, default: `13`): Google Maps zoom level. **Allowed values:** `0-18`
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-rank-tracker/search`

### GET /local-rank-tracker/calculate-grid-coordinates - Calculate Grid Coordinate Points
Get all grid coordinate points based on a center geocoordinate point and distance arguments.
Parameters:
- **lat** (number, required, default: `37.341759`): Grid center coordinate point latitude value.
- **lng** (number, required, default: `-121.938314`): Grid center coordinate point longitude value.
- **grid_size** (number, required, default: `3`, allowed: 3 | 5 | 7 | 9 | 11 | 13 | 15): The size of the grid *(i.e. 3x3, 5x5, 7x7, etc)*.
- **radius** (number, required, default: `1`): The distance between coordinate points (on the same row / column in the grid). The units of the radius are determined by the distance_units parameter. **Allowed values:** `0.1-100`
- radius_units (string, default: `km`): Distance measurement units to use for the radius parameter (kilometers / miles). **Allowed values:** `km, mi`
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-rank-tracker/calculate-grid-coordinates`

### GET /local-rank-tracker/ranking-at-coordinate - Ranking at Coordinate Point
Get search results at the specified coordinate point and additional ranking data for the business with `place_id`.
Parameters:
- **place_id** (string, required): The Google Place ID of the business to match against in results.
- **query** (string, required): Search query / keyword.
- **lat** (number, required, default: `37.341759`): Coordinate point latitude value.
- **lng** (number, required, default: `-121.938314`): Coordinate point longitude value.
- zoom (number, default: `13`): Google Maps zoom level. **Allowed values:** `0-18`
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-rank-tracker/ranking-at-coordinate`

### GET /local-rank-tracker/grid - Full Grid Search
Make a full grid search and get the ranking of a specific business in every coordinate point in the grid.
Parameters:
- **place_id** (string, required): The Google Place ID of the business to match against in results.
- **query** (string, required): Search query / keyword.
- **lat** (number, required, default: `37.341759`): Grid center coordinate point latitude value.
- **lng** (number, required, default: `-121.938314`): Grid center coordinate point longitude value.
- **grid_size** (number, required, default: `3`, allowed: 3 | 5 | 7 | 9 | 11 | 13 | 15): The size of the grid *(i.e. 3x3, 5x5, 7x7, etc)*.
- **radius** (number, required, default: `1`): The distance between coordinate points (on the same row / column in the grid). The units of the radius are determined by the distance_units parameter. **Allowed values:** `0.1-100`
- shape (string, default: `square`, allowed: square | round): The shape of the grid (square or round).
- radius_units (string, default: `km`, allowed: km | mi): Distance measurement units to use for the radius parameter (kilometers / miles)..
- zoom (number, default: `13`): Google Maps zoom level to use for search on each grid point. **Allowed values:** `0-18`
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/local-rank-tracker/grid`

### GET /waze/alerts-and-jams - Alerts and Jams
Get real-time alerts data and jams information from Waze in a geographic rectangular area by bottom-left and top-right latitude, longitude pairs.
Parameters:
- **bottom_left** (string, required): Bottom-left corner of the geographic rectangular area for which to get alerts and traffic jams. Specified as latitude, longitude pair. Required if center and radius are not specified.
- **top_right** (string, required): Top-right corner of the geographic rectangular area for which to get alerts and traffic jams. Specified as latitude, longitude pair. Required if center and radius are not specified. Required if center and radius are not specified.
- center (string): The center point of the area for which to return alerts and jams - specified as latitude, longitude pair. Required if bottom_left and top_right are not specified.
- radius (string): The radius of the area for which to return alerts and jams. Required if bottom_left and top_right are not specified. Required if bottom_left and top_right are not specified.
- radius_units (string, default: `KM`, allowed: KM | MI): The unit of measurement for the radius parameter.
- max_alerts (integer, default: `20`): Maximum number of alerts to fetch (to avoid fetching alerts set it to 0).
- max_jams (integer, default: `20`): Maximum number of traffic jams to fetch (to avoid fetching traffic jams, set it to 0).
- alert_types (string): Only return alerts of specific types. Multiple alert types can be specified as a comma (,) separated list.
- alert_subtypes (string): Only return alerts of specific subtypes types. Multiple alert subtypes can be specified as a comma (,) separated list.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/waze/alerts-and-jams`

### GET /waze/autocomplete - Autocomplete
Waze autocomplete/type-ahead functionality for places/POI, locations and addresses.
Parameters:
- **q** (string, required): Free-text geographic query.
- language (string): The language of the results. See https://wazeopedia.waze.com/wiki/USA/Countries_and_Languages for a list of supported languages.
- **coordinates** (string, required): Geographic coordinates (latitude, longitude) bias. Highly recommended to use for getting accurate results.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/waze/autocomplete`

### GET /waze/driving-directions - Driving Directions
Get routes / driving directions from Waze, including alerts along each possible route.
Parameters:
- **source_coordinates** (string, required): Geographic coordinates (latitude, longitude pair) of the starting point
- **destination_coordinates** (string, required): Geographic coordinates (latitude, longitude pair) of the destination
- return_route_coordinates (boolean): Whether to return route coordinate pairs (route_coordinates field)
- arrival_timestamp (number): Unix-timestamp (seconds since epoch) of the arrival time (in case not specified directions will be returned for current time)
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/waze/driving-directions`

### GET /waze/venues - Venues
Get venues in geographic rectangular area by bottom-left and top-right latitude, longitude pairs.
Parameters:
- **bottom_left** (string, required): Bottom-left corner of the geographic rectangular area for which to get venues. Specified as latitude, longitude pair.
- **top_right** (string, required): Top-right corner of the geographic rectangular area for which to get venues. Specified as latitude, longitude pair.
- categories (string): Only return venues in specific categories. Multiple alert types can be specified as a comma (,) separated list.
- zoom_level (string): Waze zoom level from 1-4 (4 is most zoomed in).
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/waze/venues`

### GET /driving-directions/get-directions - Get Directions
Get driving directions from an origin to a destination.
Parameters:
- **origin** (string, required): Directions origin / starting point - specified as free-text location query or latitude, longitude pair. **Examples:** `Church St & 29th St, San-Francisco, CA, USA` `37.743292, -122.420437`
- **destination** (string, required): Directions destination - specified as free-text location query or latitude, longitude pair. **Examples:** `145 5th Ave, New York, NY, USA` `40.649238, -73.974229`
- departure_time (number, default: `0`): Departure time - specified as a Unix-Timestamp in origin local time. **Example:** `1665785617`
- arrival_time (number, default: `0`): Arrival time - specified as a Unix-Timestamp in destination local time. **Example:** `1665752460`
- distance_units (string, default: `auto`, allowed: auto | km | mi): Set the distance units in the response to Kilometers or Miles. The default auto value will use the common distance units used in origin/destination (e.g. Miles in the US, Kilometers in Germany).
- avoid_routes (string): Route types to avoid - specified as a comma delimited list of the following values: `tolls`, `highways`, `ferries`. **Examples:** `ferries,tolls` `highways`
- country (string, default: `US`): The country/region to use for the query, specified as a 2-letter country code - see `ISO 3166-1 alpha-2`.
- language (string, default: `EN`): The language to use for the query, specified as a 2-letter language code - see `ISO 639-1 alpha-2`.
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/driving-directions/get-directions`

### GET /events/search-events - Search Events
Search for local public events in real-time.
Parameters:
- **query** (string, required, e.g. `Concerts in San-Francisco`): Search query / keyword.
- date (string, default: `any`, allowed: any | today | tomorrow | week | weekend | next_week | month | next_month): Return events in a certain date / time period.
- is_virtual (boolean, default: `false`): If true, only virtual events will be returned.
- start (integer, default: `0`): Number of results to skip (for pagination).
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/events/search-events`

### GET /events/event-details - Event Details
Get the details of a specific event by Event ID (i.e.
Parameters:
- **event_id** (string, required, e.g. `L2F1dGhvcml0eS9ob3Jpem9uL2NsdXN0ZXJlZF9ldmVudC8yMDI0LTExLTIyfDE2OTA0Nzc5MjUwNzQwODY5OTc4`): The ID of the event to fetch (i.e. event_id field of an event).
Full URL: `https://api.openwebninja.com/realtime-local-and-maps-data/events/event-details`

## Base URL and Authentication

- Base URL: `https://api.openwebninja.com/realtime-local-and-maps-data`
- Auth: API key in the `x-api-key` header. Get a key by subscribing (free tier available) at https://app.openwebninja.com/api/realtime-local-and-maps-data

## Links

- API page: https://www.openwebninja.com/api/realtime-local-and-maps-data
- Get an API key / subscribe: https://app.openwebninja.com/api/realtime-local-and-maps-data
- Pricing & plans: https://app.openwebninja.com/api/realtime-local-and-maps-data/pricing
- Website: https://www.openwebninja.com
- OpenAPI spec: https://openwebninja.s3.us-east-1.amazonaws.com/portal/openapi/realtime_local_and_maps_data.yaml
- Support: support@openwebninja.com

_Last updated: 2026-05-27_