---
title: "Search a BigCommerce storefront"
method: GET
path: "/bigcommerce/search"
tags: ["BigCommerce"]
---

# Search a BigCommerce storefront

`GET /bigcommerce/search`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/bigcommerce/search`
- Auth: API key in header `x-api-key`

Returns one product-search page from a public BigCommerce storefront. url must be the public storefront origin; an optional caller path or query is ignored. q is required search text. page is 1-indexed and defaults to 1.

## Query parameters

- `url` string, required
- `q` string, required
- `page` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- BigcommerceSearchResponseDoc
  - `code` integer
  - `data` BigcommerceSearchResponse
    - `page` integer
    - `products` BigcommerceProduct[]
      - `availability` string
      - `brand` string
      - `currency` string
      - `description` string
      - `id` string
      - `image` string
      - `images` string[]
      - `name` string
      - `price` number
      - `price_text` string
      - `sku` string
      - `url` string
    - `query` string
    - `source_url` string
    - `store_url` string
  - `msg` string

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)