Skip to main content
Before you start, make sure you have:
  • A Developer organization provisioned by StoreRouter
  • A Platform API key from StoreRouter Platform (see Authentication)
1

Set your API key

Export your API key so it’s available to all three methods below:
The Python and TypeScript SDKs read OCTOGEN_PLATFORM_API_KEY from the environment automatically. You can also pass the key directly to the client constructor — see Authentication for details.
2

Search products

Search every catalog your key can access using a keyword query. To search specific catalogs, add catalogs with a list of catalog keys.
The response includes an items array and a nextCursor field for pagination. When nextCursor is non-null, pass it back verbatim as cursor in your next request, with the same request body, to fetch the next page.
3

Look up a product by URL

Resolve any product page URL to its full product record — including pricing, sizing, images, and variants.
The lookup response includes the full product record with optional fields such as variants, categories, colors, reviews, promotions, and identifiers when the underlying catalog record has them.
The URL you pass must belong to an active crawled catalog. A URL from an unrecognized domain or unavailable catalog returns a 404 error.

Next steps

  • Filter searches — use catalogs, facets, exclude_facets, price_min, and price_max to narrow results, and debug to see the filters StoreRouter derived from your query. See Catalog search.
  • Find similar products — use a product URL or UUID as the source for More Like This recommendations. See More Like This.
  • Paginate results — use the nextCursor field to fetch subsequent pages. See Pagination.
  • Handle errors — understand 401, 402, 403, 404, and 422 responses. See Error handling.
  • Understand pricing — see API pricing and billing for request prices, prepaid credit, and payments.
  • Connect an AI agent — use the Developer MCP server to give Claude or Codex direct catalog access. See MCP overview.