diff --git a/docs/source/rest.html.md.erb b/docs/source/rest.html.md.erb index 36aec2dcb..39068e482 100644 --- a/docs/source/rest.html.md.erb +++ b/docs/source/rest.html.md.erb @@ -12,7 +12,9 @@ In order to guarantee a very high-availability, we recommend to implement a retr - then `https://places-2.algolianet.com`, - then `https://places-3.algolianet.com`. -### Endpoint +### Endpoints + +#### Search To search using the Algolia Places REST API, you need to target the `/1/places/query` endpoint with a `POST` request. @@ -22,6 +24,17 @@ $ curl -X POST 'https://places-dsn.algolia.net/1/places/query' --data '{"query": **Note:** The relative path prefix `/1/` indicates that we are currently using version 1 of the API. +#### Get by objectID + +To get an Algolia Places Record using the REST API, you need to target the `/1/places/{objectID}` endpoint with a `GET` request. +Replace `{objectID}` by the objectID you whish to query. + +```bash +$ curl -X GET 'https://places-dsn.algolia.net/1/places/111781_17807753' +``` + +**Note:** The relative path prefix `/1/` indicates that we are currently using version 1 of the API. + ### Authentication If you're using the authenticated version of our API (higher rate-limits), you'll need to authenticate yourself. This is done via the following HTTP headers: