Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For details about what is the API Key and how you can obtain it, see: DOCS:#API API Key.

Authentication Requirements

...

For details about how to acquire and use them, see DOCS:#API API Authentication.

URIs

URI: /restaurants/search

...

  • A map of:
    • query: The original query line sent to the search engine
    • ok: If the search was a success, should be true
    • page: Which page these results are on, should match the original query (or be 0 if not defined in the original query)
    • count: Number of results per page, should match the original query (or be 20 if not defined in the original query)
    • total: The full number of results that the search have matched; can be used to calculate total number of pages
    • time: The date/time when the query was performed in Eastern Standard Time (EST).
    • results: A list of maps, each is a location with the keys as defined in DOCS:#Location Location Field Descriptions.

URI: /restaurants/LOCATION/

...

Returns the set of information for the location as defined in DOCS:#Location Location Field Descriptions.