Loading documentation…
Loading documentation…
Search by words, image or product ID. Get product details, price context and retailer links through one API key.
Supported market codes: GB, US, DE, FR, ES, IT, AU and CA.
Send a supported market code with each discovery search. A supported code does not guarantee matches or delivery, and a search does not switch markets automatically.
Searches send bounded query details to a partner product catalogue for extra matches. See what is sent and kept and the Privacy Policy before integrating.
curl "https://simlir.com/api/v1/search?q=protein+powder&gl=gb&limit=5" \
-H "Authorization: Bearer sk_your_key"A search can return fewer products than the requested limit, including no results. The limit is a maximum, not a promise that matching products exist.
Add the hosted endpoint to an MCP client that supports Streamable HTTP. Use a customer API key where supported; ChatGPT uses the Simlir account sign-in and OAuth approval flow. Both use the same account credit and rate limits as REST.
{
"mcpServers": {
"simlir": {
"url": "https://simlir.com/api/v1/mcp",
"headers": {
"Authorization": "Bearer YOUR_API_KEY"
}
}
}
}simlir_search_productssimlir_search_products_by_imagesimlir_lookup_products_by_identifierText search and identifier lookup cost 1 credit. Image search costs 2 credits.
limit sets the total cap (1–100), not a per-lane count. A limit is a ceiling, not a promise: relevance checks, filters, duplicates, catalogue coverage and provider availability can reduce the rows.ships_from filter selects merchant shipping-origin countries, defaults to the selected market and combines multiple values with OR. It does not select delivery destinations or guarantee delivery._gsid and utm_* are removed before a link reaches the search result; product paths and other functional query parameters are kept.Both clients call the same REST API. You still need a Simlir account, an API key and credits for requests.
TypeScript
npm install simlir-js
import { Simlir } from 'simlir-js';
const simlir = new Simlir({ apiKey: process.env.SIMLIR_API_KEY });
const result = await simlir.search({
query: 'wireless headphones',
market: 'GB',
limit: 5,
});
process.stdout.write(JSON.stringify(result.results, null, 2));Python
python -m pip install simlir
from simlir import Simlir
client = Simlir(api_key="YOUR_API_KEY")
result = client.search(
query="wireless headphones",
market="GB",
limit=5,
)
print(result.results)Keep SIMLIR_API_KEY in your server environment. Never commit it or send it to a browser.
Send your API key in the Authorization: Bearer header. Discovery search endpoints require one of the supported market codes listed above. Coverage can vary by market, filters and catalogue availability; requests stay within the market you select.
GET /api/v1/search1 creditUse q for the shopper's request and gl for the market. Optional filters include category, brand, price range, repeated ships_fromorigin codes, limit (up to 100 total results) and offset (0–99).
POST /api/v1/search/image2 creditsSend a publicly reachable HTTPS image URL and a market. Add a text query when the shopper has extra requirements.
curl -X POST "https://simlir.com/api/v1/search/image" \
-H "Authorization: Bearer sk_your_key" \
-H "Content-Type: application/json" \
-d '{
"image_url": "https://example.com/product.jpg",
"market": "gb",
"query": "a slim fridge freezer for a small kitchen",
"limit": 5
}'GET /api/v1/lookup1 creditFind a product when you already have its GTIN, MPN or retailer SKU. Send the market and, when useful, the retailer name.
curl "https://simlir.com/api/v1/lookup?identifier=8806095048789&type=gtin&gl=gb" \
-H "Authorization: Bearer sk_your_key"GET /api/v1/product1 creditFetch one product by the UUID returned in a search result.
Full parameter definitions are in the OpenAPI contract.
| Account | Requests/min | Burst/10 sec | Daily | Concurrent | Credits/min |
|---|---|---|---|---|---|
| Free | 60 | 20 | No cap | 5 | 100 |
| Standard | 5,000 | 750 | No cap | 50 | 2,500 |
| Enterprise | Custom | ||||
These are request limits; each operation also uses credits. Rate-limit responses include Retry-After. See pricing for current credit costs and account options.
Each product can include its title, identifiers, specifications, image, review details, price snapshot and retailer links. Fields vary by product; missing data is not inferred.
Brand, category, identifiers and available specifications.
Amount, currency, retailer and snapshot date when available.
A relevance score and product evidence to help your agent explain its choice.
A product page is preferred; cart and checkout links are used only when no usable product page is available, and a merchant homepage is not used as a product link.
Price and stock can change. A recorded price is a snapshot, not a live checkout quote or a guarantee that a retailer still has the item.
The API contract defines the request and response fields for REST and hosted MCP. SDK source is Apache-2.0; that licence does not cover the hosted service, returned product data or Simlir trademarks.
For API integration support or a security report, email technology@simlir.com. If you have a request ID, include it. Do not email API keys, passwords, or customer data.