Apollo Pharmacy Suggestions Search
apollo-pharmacy.search.suggest
Read the search suggestions Apollo Pharmacy offers while a query is being typed, with their category.
At a glance
- Endpoint ID
apollo-pharmacy.search.suggest- Price
- 1 credit per call; failed calls are free
- Runs for up to
- 45 seconds
Request
Send the endpoint ID as capability and its fields as input. Set UPSCRAPE_API_KEY to your key first.
curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "capability": "apollo-pharmacy.search.suggest", "input": { "query": "parac" }}'
import jsonimport osimport requestspayload = json.loads(r'''{ "capability": "apollo-pharmacy.search.suggest", "input": { "query": "parac" }}''')response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload,)response.raise_for_status()print(json.dumps(response.json(), indent=2))
const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": `Bearer ${process.env.UPSCRAPE_API_KEY}`, "Content-Type": "application/json", "Prefer": "wait=30", }, body: JSON.stringify({ "capability": "apollo-pharmacy.search.suggest", "input": { "query": "parac" }}),});if (!response.ok) { throw new Error(`Upscrape request failed: ${response.status}`);}console.log(JSON.stringify(await response.json(), null, 2));
Input
| Field | Type | Required | What it does | Example |
|---|---|---|---|---|
query |
string | yes | Partial query the customer is typing. | parac |
pincode |
string | no | Indian PIN code used to localise prices, substitutes, offers and availability. |
Response
A finished call answers with HTTP 200; the data is in results[0].data, and billing.credits_charged is what it cost. A call still running after the wait answers 202: see jobs and results.
This is results[0].data from a real run:
{ "suggestions": [ { "name": "Show results for acetaminophen - serum in lab tests", "category": "lab tests", "sub_text": "in Lab tests", "thumbnail": "https://images.apollo247.in/images/icons/blood_test_tube.png", "type": "LOB" }, { "name": "Get Expert Advise: Medicines, dosage, and safe use", "category": "others", "sub_text": "Medicines, dosage, and safe use", "thumbnail": "https://images.apollo247.in/images/askApolloV3/images/logo.png", "type": "others" } ]}
Fields
| Field | Type | Example |
|---|---|---|
suggestions[].name |
string | Show results for acetaminophen - serum in lab tests |
suggestions[].category |
string | lab tests |
suggestions[].sub_text |
string | in Lab tests |
suggestions[].thumbnail |
string | https://images.apollo247.in/images/icons/blood_test_tube.png |
suggestions[].type |
string | LOB |
suggestions |
array | 3 records |
If a call fails
A failed call costs nothing. The response carries an error.code you can branch on; Errors and retries lists every code and which ones to retry.
Other Apollo Pharmacy endpoints
apollo-pharmacy.brand.productsBrand productsapollo-pharmacy.categories.listCategoriesapollo-pharmacy.category.productsCategory productsapollo-pharmacy.pincode.checkCheck PIN codeapollo-pharmacy.product.getProductapollo-pharmacy.product.offersProduct offersapollo-pharmacy.product.reviewsProduct reviewsapollo-pharmacy.product.substitutesProduct substitutesapollo-pharmacy.search.productsProducts searchapollo-pharmacy.stores.nearNearby storesapollo-pharmacy.trending.searchesTrending searches
Something missing or unclear? Ask the team that builds the Apollo Pharmacy endpoints.