Search for locations.
Changed onReturns a cursor-paginated list of locations matching a keyword, searchable by name, address, or store ID.
Request
- Base URLhttps://listingsapi.com
- Auth
- API key in header Authorization
- or API key in header X-RapidAPI-Key and API key in header X-RapidAPI-Host
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Search keyword matched against location name, street address, city, and store ID. Omit to page through every location.
JSON-encoded filter object
JSON-encoded filter object to narrow results (for example by approval status).
Number of records to return, counting forward from the start of the result set.
Cursor to page forward from. Pass pageInfo.endCursor, or equivalently the cursor of the last edge in the previous page. Stop paging when pageInfo.hasNextPage is false, or when a page returns an empty edges array.
Response
Successful response
Changes
- breaking
added to the response body
oneOflist for the response status - info
removed from the response body
oneOflist for the response status
- breaking
- breaking
added to the response body
oneOflist for the response status - breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking