Overview

Retrieve a list of restaurants on the Stellar Menus platform.

Request

Endpoint:	/v1/restaurants
Method:	GET
Headers:	Authorization: <Your-API-Key>

When forming your request, use the following JSON payload structures.

1. To filter by the initial characters:

{
   "starts_with": "some-string"
}

Replace “some-string” with your desired starting characters.

2. To search for a sequence of 4 consecutive characters appearing anywhere in the restaurant's name:

{
   "contains": "wxyz"
}

Replace “wxyz” with your desired character sequence.

Note:

You can't use both parameters in a single request.
If more than 25 records match your criteria, only the first 25 will be returned.

Response

The API will respond with a JSON containing the restaurant_id and display_name for the restaurants matching the criteria.

Example Request Body

{
   "starts_with": "str"
}

Expected Response

[ 
   { 
      "restaurant_id": "507f1f77bcf86cd799439011", 
      "display_name": "Restaurant A" 
   }, 
   { 
      "restaurant_id": "507f191e810c19729de860ea", 
      "display_name": "Restaurant B" 
   }, 
   // ... other restaurants ...
]