Skip to content

Product Search API

Beta

POST /products/search

The Product Search API takes a shopping query, such as “wireless mouse”, and returns up to 40 products ranked by relevance to it, each with a title, a link to the store and, where known, a price and a picture. Unlike the Web Search API, the request and the response are Elo’s own shape, the same for every query.

https://api.elo.ad/v1

Create your publisher API key on the Integration page of the Elo dashboard. Rotating it there revokes the previous key immediately. Send it in Authorization: Bearer or in X-API-Key.

Terminal window
curl -X POST "https://api.elo.ad/v1/products/search" \
-H "Authorization: Bearer elo_pub_..." \
-H "Content-Type: application/json" \
-d '{ "q": "wireless mouse", "country": "us", "language": "en", "num": 5 }'
FieldDescription
qThe shopping query. Required, up to 2048 characters.
countryTwo-letter country code, lower case, for example us. Defaults to the US.
languageLanguage code, lower case, for example en or pt-br.
numMost products to return, 1 to 40. Defaults to 5.
{
"products": [
{
"title": "Logitech M170 Wireless Mouse",
"url": "https://api.elo.ad/v1/products/go/q3vT9kLm2Pwx",
"merchant": "Best Buy",
"price": "$14.99",
"image_url": "https://images.example.com/logitech-m170.jpg",
"position": 1
}
]
}
FieldDescription
titleProduct name.
urlElo’s link to the product. See Links.
merchantThe store Google Shopping lists it from, when known.
priceThe price Google Shopping lists, currency included, when known.
image_urlProduct picture, when known.
positionRank by relevance, from 1.

The X-Request-ID response header identifies the call in Elo’s logs. Quote it when reporting a problem.

Each product’s url is Elo’s link. When opened, it redirects to the product’s page at the store, or to Google Shopping’s page when Elo finds no store page. Open it in a new tab or the system browser. A link opens the store page for 7 days after the search, and Google Shopping’s page after that. After 90 days it stops working.

Elo monetizes links on a best-effort basis: where it can, the redirect goes through a tracked link to the same page. Monetization never changes which products are returned or their order.

StatusMeaning
401The publisher API key is missing or not valid.
422The request does not match the schema. The body says which field.
502, 503, 504Internal server error. Retry later.