# Big W API — Australian product search, prices by state, stock by store, barcodes and reviews from bigw.com.au

> Search the whole bigw.com.au catalogue (BIG W's range and Marketplace sellers) with every filter of the site's listing pages — category, brand, price range, deal type, sold by, star rating, in stock, size, colour, gender, condition, recommended age, home delivery / pick up — sorted by relevance, price, name or newest. Each row is a full product summary: name, brand, the shelf price of every state, Was price and saving, clearance / deal labels, stock flag, rating, description, specification values, EAN / GTIN barcodes, categories, seller and delivery options. Up to 150 rows per page; the site stops at 2,000 results per search (`total` is the full count). The facet list with counts comes back too.
> ReefAPI engine `bigw` · 13 endpoints · clean JSON, no scraping or browsers to manage.

## How to call
- **Endpoint:** `POST https://api.reefapi.com/bigw/v1/<action>` with a JSON body.
- **Auth:** header `x-api-key: <YOUR_REEFAPI_KEY>` — create one free (1,000 credits, no card): https://reefapi.com/signup
- **Response (every call):** `{ ok: boolean, data: ..., meta: { record_count, credits, ... }, error: { code, message } }` — branch on `ok`. Failed calls are free.
- **One key + one shared credit pool** across every ReefAPI API. Per-call credits are listed on each endpoint below.
- **Use it from an AI agent (MCP):** connect `https://api.reefapi.com/mcp` (remote streamable-http). Clients that add connectors by URL, such as ChatGPT and the Claude app, connect with OAuth 2.1 (the user pastes their key once on a ReefAPI page; discovery at `/.well-known/oauth-protected-resource/mcp`). Config files send the key as `Authorization: Bearer <key>`. `?key=<key>` in the URL also works as a last-resort fallback.

## Endpoints

### POST https://api.reefapi.com/bigw/v1/search — 1 credit
Search the whole bigw.com.au catalogue (BIG W's range and Marketplace sellers) with every filter of the site's listing pages — category, brand, price range, deal type, sold by, star rating, in stock, size, colour, gender, condition, recommended age, home delivery / pick up — sorted by relevance, price, name or newest. Each row is a full product summary: name, brand, the shelf price of every state, Was price and saving, clearance / deal labels, stock flag, rating, description, specification values, EAN / GTIN barcodes, categories, seller and delivery options. Up to 150 rows per page; the site stops at 2,000 results per search (`total` is the full count). The facet list with counts comes back too.

**Parameters:**
- `query` (string, optional) — What to search for, as typed in the site's search box (`lego`, `kettle`). An EAN / article id finds that one product.
- `category` (string, optional) — Limit to a category: its code (`6822101` = LEGO) or a bigw.com.au category link (`categories` lists every code).
- `brand` (array, optional) — Brand name(s) as the site lists them (`LEGO`, `Apple`); case does not matter; up to 15 = any of them. A bigw.com.au/brands/<brand> link works.
- `min_price` (number, optional) — Lowest shelf price in AUD (dollars).
- `max_price` (number, optional) — Highest shelf price in AUD (dollars).
- `deal` (array, optional) — Deal type(s): special, clearance, price_drop, lowest_price_14_days, lowest_price_7_days, new, multi_buy, low_price, bundle, big_deal, flash_deal (the site's labels work too); several = any of them.
- `sold_by` (enum, optional) — bigw (BIG W's own range) or marketplace (Marketplace sellers). [one of: bigw, marketplace]
- `rating` (array, optional) — Exact star rating(s) 1-5 as the site's filter works (`4` = 4-star products only); several = any.
- `min_rating` (integer, optional) — Star rating N and up (expands to N..5).
- `in_stock` (boolean, optional) — Only products in stock (true). `false` is ignored by the site, so it is not sent.
- `size` (array, optional) — Size facet value(s) exactly as the `facets` list shows them (`12`, `2XL`).
- `colour` (array, optional) — Colour facet value(s) as the `facets` list shows them (`Black`).
- `gender` (array, optional) — mens, womens, boys, girls, unisex (the site's five values; several = any).
- `condition` (array, optional) — new, used or refurbished (several = any).
- `recommended_age` (array, optional) — Recommended-age facet value(s) (`6 years +`), toys.
- `fulfilment` (array, optional) — home_delivery or pickup (free pick up).
- `sort` (enum, optional, default "relevance") — relevance (default), price_asc, price_desc, name_asc, name_desc, newest. [one of: relevance, price_asc, price_desc, name_asc, name_desc, newest]
- `page` (integer, optional, default 1) — Result page, 1-based. The site stops at 2,000 results (page 42 at 48 per page).
- `per_page` (integer, optional, default 48) — Rows per page, 1-150 (the site's maximum; its own pages use 48).
- `state` (enum, optional, default "NAT") — Which state's shelf price fills the price fields: NAT (national, default), NSW, VIC, QLD, WA, SA, TAS, ACT, NT (full names work). [one of: NAT, NSW, VIC, QLD, WA, SA, TAS, ACT, NT]

**Returns:** total, reachable (the site stops at 2,000), total_is_capped, total_pages, page, per_page, has_more, state, sort, applied{}, rows[]{id, name, url, brand, brand_url, brand_logo, price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, price_label, price_state, is_clearance, prices_by_state{NAT,NSW,VIC,QLD,WA,SA,TAS,ACT,NT: {price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, rrp_aud, was_date, unit_price, label, label_type, price_type, is_clearance, is_online_only_promotion, promotions[]}}, promo_labels[]{type, text}, in_stock, rating, image{small, medium, large}, badges[], description, summary, specifications[]{name, values[]}, colours[], sizes[], variant_ids[], sold_by, product_channel, vendors[]{id, name}, seller{id, name} (Marketplace), supplier{id, name} (BIG W range), categories[]{id, name, url}, category_paths[][], collections[]{id, name}, classifications[], identifiers{article_id, gtin, ean, mpn, barcodes[]{barcode, type, is_primary}}, listing_status, lifecycle_status, condition, max_quantity, is_deliverable, is_collectable, has_limited_free_shipping, has_button_cell_battery, is_recalled, online_from, approved_at, payment_options{afterpay, zip, layby}, fulfilment{home_delivery_standard, home_delivery_express, home_delivery_priority, delivery_min_fee_aud, pickup, layby, preorder, drop_ship, logistic_type, colours_in_stock, sizes_in_stock}}, facets[]{filter, label, type, min, max, values[]{value, count}}, suggestions[], redirect_url, query_categorization[], sponsored[]

**Example request body:**
```json
{
  "query": "lego"
}
```

### POST https://api.reefapi.com/bigw/v1/barcode — 1 credit
Find the Big W product for an EAN / GTIN barcode (or an article id): the same full row as `search`, only when a product carries exactly that code.

**Parameters:**
- `barcode` (string, required) — EAN-13 / EAN-8 / GTIN-14 / UPC digits, or a Big W article id.
- `state` (enum, optional, default "NAT") — Which state's shelf price fills the price fields: NAT (national, default), NSW, VIC, QLD, WA, SA, TAS, ACT, NT (full names work). [one of: NAT, NSW, VIC, QLD, WA, SA, TAS, ACT, NT]

**Returns:** match{id, name, url, brand, brand_url, brand_logo, price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, price_label, price_state, is_clearance, prices_by_state{NAT,NSW,VIC,QLD,WA,SA,TAS,ACT,NT: {price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, rrp_aud, was_date, unit_price, label, label_type, price_type, is_clearance, is_online_only_promotion, promotions[]}}, promo_labels[]{type, text}, in_stock, rating, image{small, medium, large}, badges[], description, summary, specifications[]{name, values[]}, colours[], sizes[], variant_ids[], sold_by, product_channel, vendors[]{id, name}, seller{id, name} (Marketplace), supplier{id, name} (BIG W range), categories[]{id, name, url}, category_paths[][], collections[]{id, name}, classifications[], identifiers{article_id, gtin, ean, mpn, barcodes[]{barcode, type, is_primary}}, listing_status, lifecycle_status, condition, max_quantity, is_deliverable, is_collectable, has_limited_free_shipping, has_button_cell_battery, is_recalled, online_from, approved_at, payment_options{afterpay, zip, layby}, fulfilment{home_delivery_standard, home_delivery_express, home_delivery_priority, delivery_min_fee_aud, pickup, layby, preorder, drop_ship, logistic_type, colours_in_stock, sizes_in_stock}}}, matched_on

**Example request body:**
```json
{
  "barcode": "5702016617757"
}
```

### POST https://api.reefapi.com/bigw/v1/product — 2 credits
The full product record: every image and video, the specification table (dimensions, weight, materials, care), EAN, shipping and cubic weight, delivery options, size and colour variants (each with its own price), Marketplace seller, the state price with Was price, RRP, saving, promotion label, Afterpay instalment and Zip eligibility, every state's shelf price, the in-stock flag and the review summary (count, average, star histogram, recommended).

**Parameters:**
- `product` (string, required) — Big W article id (`80247`, `1796556-violet`, `9906042643`) — the `id` of a search row — or a bigw.com.au product link.
- `state` (enum, optional, default "NAT") — Which state's shelf price fills the price fields: NAT (national, default), NSW, VIC, QLD, WA, SA, TAS, ACT, NT (full names work). [one of: NAT, NSW, VIC, QLD, WA, SA, TAS, ACT, NT]

**Returns:** id, name, url, brand, brand_url, brand_logo, description, summary, rating, images[]{url, alt, zoom, large, medium, small, thumbnail, source}, videos[], badges[], specifications[]{name, value}, identifiers{article_id, ean, gtin, barcodes[], manufacturer_part_id, external_base_id}, listing_status, online_from, sold_by, product_channel, seller{id, name}, shipping{weight_kg, cubic_weight_kg, logistic_type, display_delivery_fee_aud, po_box_deliverable}, max_quantity, giftable, has_button_cell_battery, flags{deliverable, collectable, express_delivery, layby, home_delivery_only, online_only, in_store_only, preorder, bundle, drop_ship, base_product, variant, ...}, delivery_options[], categories[]{id, name, url}, category_paths[][], collections[], colour{name, hex}, size, colour_options[]{product_id, name, hex, url}, base_product_id, variant_ids[], variants[]{id, name, url, size, colour, listing_status, flags, identifiers, max_quantity, online_from, pricing}, pricing{state, price_aud, price_cents, max_price_aud, was_price_aud, was_price_date, rrp_aud, saving_aud, max_saving_aud, unit_price, label, label_type, promotions[], potential_promotions[], is_online_only_promotion, afterpay_instalment_aud, zip_pay_eligible, min_delivery_cost_aud, source}, prices_by_state{...}, in_stock, promo_labels[], reviews{total_reviews, average_rating, rating_histogram{5..1}, recommended_count, not_recommended_count}

**Example request body:**
```json
{
  "product": "80247"
}
```

### POST https://api.reefapi.com/bigw/v1/price — 2 credits
Just the price of one product in one state, light: price, Was price and date, RRP, saving, promotion label and messages, unit price, Afterpay instalment, Zip eligibility, minimum delivery cost; a base product with sizes is priced per variant.

**Parameters:**
- `product` (string, required) — Big W article id (`80247`, `1796556-violet`, `9906042643`) — the `id` of a search row — or a bigw.com.au product link.
- `state` (enum, optional, default "NAT") — Which state's shelf price fills the price fields: NAT (national, default), NSW, VIC, QLD, WA, SA, TAS, ACT, NT (full names work). [one of: NAT, NSW, VIC, QLD, WA, SA, TAS, ACT, NT]

**Returns:** product_id, state, price_aud, price_cents, max_price_aud, was_price_aud, was_price_date, rrp_aud, saving_aud, max_saving_aud, unit_price, label, label_type, promotions[], potential_promotions[], is_online_only_promotion, afterpay_instalment_aud, zip_pay_eligible, min_delivery_cost_aud, priced_from_variants, variants[]{product_id, price_aud, ...}

**Example request body:**
```json
{
  "product": "80247"
}
```

### POST https://api.reefapi.com/bigw/v1/stock — 2 credits
In-store stock and pick-up availability of a product at one or several BIG W stores in ONE call (the site answers several stores at once): status (inStock / lowStock / outOfStock), available, pick-up capacity, drive-up and service-desk pick-up; for clothing every size variant. Without `store`, the stores of `state` (or of a `postcode`'s state). Online-only / Marketplace items: "Not sold in store" as on the site.

**Parameters:**
- `product` (string, required) — Big W article id (`80247`, `1796556-violet`, `9906042643`) — the `id` of a search row — or a bigw.com.au product link.
- `store` (array, optional) — Store id(s) (`0130`) or bigw.com.au/store links — up to 20.
- `state` (string, optional) — Without `store`: every store of this state (NSW, VIC, QLD, WA, SA, TAS, ACT, NT).
- `postcode` (string, optional) — Without `store`: the stores whose postcode is nearest to this one (same state, by postcode distance; 4 digits).
- `limit` (integer, optional, default 10) — How many stores when chosen by state / postcode, 1-20 (default 10).

**Returns:** product{id, url}, store_ids[], stores[]{id, name, url, phone, address, in_store{available, quantity, status}, pickup{available, quantity, status, capacity, drive_up, service_desk}}, variants[]{id, size, stores[]}, delivery, min_delivery_fee_aud, store_stock_source (availability | listing_status); when the site refuses the stock lookup for an item not sold in stores: sold_in_store false, not_sold_in_store_reason, online_in_stock, note, in_store.status notSoldInStore

**Example request body:**
```json
{
  "product": "80247"
}
```

### POST https://api.reefapi.com/bigw/v1/reviews — 1 credit
A product's customer reviews (Bazaarvoice, the site's own review provider): star rating, title, full text, reviewer nickname, date, recommended, incentivised badge, quality / value sub-ratings, photos, helpful votes, BIG W replies; with the product's statistics (count, average, star histogram, recommended count, first / last review date). Sort, star filter, photo filter; up to 100 per page.

**Parameters:**
- `product` (string, required) — Big W article id (`80247`, `1796556-violet`, `9906042643`) — the `id` of a search row — or a bigw.com.au product link.
- `sort` (enum, optional, default "newest") — newest (default), oldest, highest, lowest, most_helpful. [one of: newest, oldest, highest, lowest, most_helpful]
- `rating` (array, optional) — Only reviews with these star ratings (1-5); several = any.
- `with_photos` (boolean, optional) — Only reviews that carry photos.
- `page` (integer, optional, default 1) — Page, 1-based.
- `per_page` (integer, optional, default 20) — Reviews per page, 1-100 (Bazaarvoice maximum).

**Returns:** product{id, name, brand, image, url, eans[]}, total, total_pages, page, per_page, has_more, sort, statistics{total_reviews, average_rating, rating_histogram, recommended_count, not_recommended_count, ratings_only_count, photo_count, helpful_votes, secondary_rating_averages, first_review_at, last_review_at}, filtered_statistics, rows[]{id, rating, title, text, author, author_location, submitted_at, is_recommended, incentivized, badges[], secondary_ratings, helpful_votes, not_helpful_votes, photos[], videos[], business_responses[], is_syndicated, syndication_source, product_name_at_review}

**Example request body:**
```json
{
  "product": "80247"
}
```

### POST https://api.reefapi.com/bigw/v1/categories — 0 credits
The site's category tree (4,500+ categories): code, name, short name, image, parent, number of subcategories — the whole top level, or the subtree under one category, down to `depth` levels.

**Parameters:**
- `category` (string, optional) — Root category code or link; empty = the top level.
- `depth` (integer, optional, default 1) — Levels below the root, 1-6 (default 1).

**Returns:** root{id, name, parent_id}, count, categories[]{id, parent_id, name, short_name, url, image, active, hidden_from_menu, updated_at, subcategory_count, subcategories[]}

**Example request body:**
```json
{
  "category": "68"
}
```

### POST https://api.reefapi.com/bigw/v1/category — 2 credits
One category page: its name, direct subcategories, SEO title and description, and its products with every filter and sort of `search` (query narrows within the category).

**Parameters:**
- `category` (string, required) — Category code (`6822101`) or a bigw.com.au category link.
- `query` (string, optional) — What to search for, as typed in the site's search box (`lego`, `kettle`). An EAN / article id finds that one product.
- `brand` (array, optional) — Brand name(s) as the site lists them (`LEGO`, `Apple`); case does not matter; up to 15 = any of them. A bigw.com.au/brands/<brand> link works.
- `min_price` (number, optional) — Lowest shelf price in AUD (dollars).
- `max_price` (number, optional) — Highest shelf price in AUD (dollars).
- `deal` (array, optional) — Deal type(s): special, clearance, price_drop, lowest_price_14_days, lowest_price_7_days, new, multi_buy, low_price, bundle, big_deal, flash_deal (the site's labels work too); several = any of them.
- `sold_by` (enum, optional) — bigw (BIG W's own range) or marketplace (Marketplace sellers). [one of: bigw, marketplace]
- `rating` (array, optional) — Exact star rating(s) 1-5 as the site's filter works (`4` = 4-star products only); several = any.
- `min_rating` (integer, optional) — Star rating N and up (expands to N..5).
- `in_stock` (boolean, optional) — Only products in stock (true). `false` is ignored by the site, so it is not sent.
- `size` (array, optional) — Size facet value(s) exactly as the `facets` list shows them (`12`, `2XL`).
- `colour` (array, optional) — Colour facet value(s) as the `facets` list shows them (`Black`).
- `gender` (array, optional) — mens, womens, boys, girls, unisex (the site's five values; several = any).
- `condition` (array, optional) — new, used or refurbished (several = any).
- `recommended_age` (array, optional) — Recommended-age facet value(s) (`6 years +`), toys.
- `fulfilment` (array, optional) — home_delivery or pickup (free pick up).
- `sort` (enum, optional, default "relevance") — relevance (default), price_asc, price_desc, name_asc, name_desc, newest. [one of: relevance, price_asc, price_desc, name_asc, name_desc, newest]
- `page` (integer, optional, default 1) — Result page, 1-based. The site stops at 2,000 results (page 42 at 48 per page).
- `per_page` (integer, optional, default 48) — Rows per page, 1-150 (the site's maximum; its own pages use 48).
- `state` (enum, optional, default "NAT") — Which state's shelf price fills the price fields: NAT (national, default), NSW, VIC, QLD, WA, SA, TAS, ACT, NT (full names work). [one of: NAT, NSW, VIC, QLD, WA, SA, TAS, ACT, NT]

**Returns:** category{id, name, url, subcategories[], seo_title, title, description}, total, reachable (the site stops at 2,000), total_is_capped, total_pages, page, per_page, has_more, state, sort, applied{}, rows[]{id, name, url, brand, brand_url, brand_logo, price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, price_label, price_state, is_clearance, prices_by_state{NAT,NSW,VIC,QLD,WA,SA,TAS,ACT,NT: {price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, rrp_aud, was_date, unit_price, label, label_type, price_type, is_clearance, is_online_only_promotion, promotions[]}}, promo_labels[]{type, text}, in_stock, rating, image{small, medium, large}, badges[], description, summary, specifications[]{name, values[]}, colours[], sizes[], variant_ids[], sold_by, product_channel, vendors[]{id, name}, seller{id, name} (Marketplace), supplier{id, name} (BIG W range), categories[]{id, name, url}, category_paths[][], collections[]{id, name}, classifications[], identifiers{article_id, gtin, ean, mpn, barcodes[]{barcode, type, is_primary}}, listing_status, lifecycle_status, condition, max_quantity, is_deliverable, is_collectable, has_limited_free_shipping, has_button_cell_battery, is_recalled, online_from, approved_at, payment_options{afterpay, zip, layby}, fulfilment{home_delivery_standard, home_delivery_express, home_delivery_priority, delivery_min_fee_aud, pickup, layby, preorder, drop_ship, logistic_type, colours_in_stock, sizes_in_stock}}, facets[]{filter, label, type, min, max, values[]{value, count}}, suggestions[], redirect_url, query_categorization[], sponsored[]

**Example request body:**
```json
{
  "category": "6822101"
}
```

### POST https://api.reefapi.com/bigw/v1/brand — 1 credit
Every product of one brand on bigw.com.au, with every filter and sort of `search`.

**Parameters:**
- `brand` (string, required) — Brand name (`LEGO`) or a bigw.com.au/brands/<brand> link.
- `query` (string, optional) — What to search for, as typed in the site's search box (`lego`, `kettle`). An EAN / article id finds that one product.
- `category` (string, optional) — Limit to a category: its code (`6822101` = LEGO) or a bigw.com.au category link (`categories` lists every code).
- `min_price` (number, optional) — Lowest shelf price in AUD (dollars).
- `max_price` (number, optional) — Highest shelf price in AUD (dollars).
- `deal` (array, optional) — Deal type(s): special, clearance, price_drop, lowest_price_14_days, lowest_price_7_days, new, multi_buy, low_price, bundle, big_deal, flash_deal (the site's labels work too); several = any of them.
- `sold_by` (enum, optional) — bigw (BIG W's own range) or marketplace (Marketplace sellers). [one of: bigw, marketplace]
- `rating` (array, optional) — Exact star rating(s) 1-5 as the site's filter works (`4` = 4-star products only); several = any.
- `min_rating` (integer, optional) — Star rating N and up (expands to N..5).
- `in_stock` (boolean, optional) — Only products in stock (true). `false` is ignored by the site, so it is not sent.
- `size` (array, optional) — Size facet value(s) exactly as the `facets` list shows them (`12`, `2XL`).
- `colour` (array, optional) — Colour facet value(s) as the `facets` list shows them (`Black`).
- `gender` (array, optional) — mens, womens, boys, girls, unisex (the site's five values; several = any).
- `condition` (array, optional) — new, used or refurbished (several = any).
- `recommended_age` (array, optional) — Recommended-age facet value(s) (`6 years +`), toys.
- `fulfilment` (array, optional) — home_delivery or pickup (free pick up).
- `sort` (enum, optional, default "relevance") — relevance (default), price_asc, price_desc, name_asc, name_desc, newest. [one of: relevance, price_asc, price_desc, name_asc, name_desc, newest]
- `page` (integer, optional, default 1) — Result page, 1-based. The site stops at 2,000 results (page 42 at 48 per page).
- `per_page` (integer, optional, default 48) — Rows per page, 1-150 (the site's maximum; its own pages use 48).
- `state` (enum, optional, default "NAT") — Which state's shelf price fills the price fields: NAT (national, default), NSW, VIC, QLD, WA, SA, TAS, ACT, NT (full names work). [one of: NAT, NSW, VIC, QLD, WA, SA, TAS, ACT, NT]

**Returns:** brand{name, url}, total, reachable (the site stops at 2,000), total_is_capped, total_pages, page, per_page, has_more, state, sort, applied{}, rows[]{id, name, url, brand, brand_url, brand_logo, price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, price_label, price_state, is_clearance, prices_by_state{NAT,NSW,VIC,QLD,WA,SA,TAS,ACT,NT: {price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, rrp_aud, was_date, unit_price, label, label_type, price_type, is_clearance, is_online_only_promotion, promotions[]}}, promo_labels[]{type, text}, in_stock, rating, image{small, medium, large}, badges[], description, summary, specifications[]{name, values[]}, colours[], sizes[], variant_ids[], sold_by, product_channel, vendors[]{id, name}, seller{id, name} (Marketplace), supplier{id, name} (BIG W range), categories[]{id, name, url}, category_paths[][], collections[]{id, name}, classifications[], identifiers{article_id, gtin, ean, mpn, barcodes[]{barcode, type, is_primary}}, listing_status, lifecycle_status, condition, max_quantity, is_deliverable, is_collectable, has_limited_free_shipping, has_button_cell_battery, is_recalled, online_from, approved_at, payment_options{afterpay, zip, layby}, fulfilment{home_delivery_standard, home_delivery_express, home_delivery_priority, delivery_min_fee_aud, pickup, layby, preorder, drop_ship, logistic_type, colours_in_stock, sizes_in_stock}}, facets[]{filter, label, type, min, max, values[]{value, count}}, suggestions[], redirect_url, query_categorization[], sponsored[]

**Example request body:**
```json
{
  "brand": "LEGO"
}
```

### POST https://api.reefapi.com/bigw/v1/deals — 1 credit
Products on a deal: every deal type by default (special, clearance, price drop, lowest price in 7 / 14 days, multi-buy, low price, bundle, big deal, flash deal, new) or the ones asked for, with every filter and sort of `search`.

**Parameters:**
- `query` (string, optional) — What to search for, as typed in the site's search box (`lego`, `kettle`). An EAN / article id finds that one product.
- `category` (string, optional) — Limit to a category: its code (`6822101` = LEGO) or a bigw.com.au category link (`categories` lists every code).
- `brand` (array, optional) — Brand name(s) as the site lists them (`LEGO`, `Apple`); case does not matter; up to 15 = any of them. A bigw.com.au/brands/<brand> link works.
- `min_price` (number, optional) — Lowest shelf price in AUD (dollars).
- `max_price` (number, optional) — Highest shelf price in AUD (dollars).
- `deal` (array, optional) — Deal type(s): special, clearance, price_drop, lowest_price_14_days, lowest_price_7_days, new, multi_buy, low_price, bundle, big_deal, flash_deal (the site's labels work too); several = any of them.
- `sold_by` (enum, optional) — bigw (BIG W's own range) or marketplace (Marketplace sellers). [one of: bigw, marketplace]
- `rating` (array, optional) — Exact star rating(s) 1-5 as the site's filter works (`4` = 4-star products only); several = any.
- `min_rating` (integer, optional) — Star rating N and up (expands to N..5).
- `in_stock` (boolean, optional) — Only products in stock (true). `false` is ignored by the site, so it is not sent.
- `size` (array, optional) — Size facet value(s) exactly as the `facets` list shows them (`12`, `2XL`).
- `colour` (array, optional) — Colour facet value(s) as the `facets` list shows them (`Black`).
- `gender` (array, optional) — mens, womens, boys, girls, unisex (the site's five values; several = any).
- `condition` (array, optional) — new, used or refurbished (several = any).
- `recommended_age` (array, optional) — Recommended-age facet value(s) (`6 years +`), toys.
- `fulfilment` (array, optional) — home_delivery or pickup (free pick up).
- `sort` (enum, optional, default "relevance") — relevance (default), price_asc, price_desc, name_asc, name_desc, newest. [one of: relevance, price_asc, price_desc, name_asc, name_desc, newest]
- `page` (integer, optional, default 1) — Result page, 1-based. The site stops at 2,000 results (page 42 at 48 per page).
- `per_page` (integer, optional, default 48) — Rows per page, 1-150 (the site's maximum; its own pages use 48).
- `state` (enum, optional, default "NAT") — Which state's shelf price fills the price fields: NAT (national, default), NSW, VIC, QLD, WA, SA, TAS, ACT, NT (full names work). [one of: NAT, NSW, VIC, QLD, WA, SA, TAS, ACT, NT]

**Returns:** deals[], total, reachable (the site stops at 2,000), total_is_capped, total_pages, page, per_page, has_more, state, sort, applied{}, rows[]{id, name, url, brand, brand_url, brand_logo, price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, price_label, price_state, is_clearance, prices_by_state{NAT,NSW,VIC,QLD,WA,SA,TAS,ACT,NT: {price_aud, price_cents, max_price_aud, was_price_aud, saving_aud, rrp_aud, was_date, unit_price, label, label_type, price_type, is_clearance, is_online_only_promotion, promotions[]}}, promo_labels[]{type, text}, in_stock, rating, image{small, medium, large}, badges[], description, summary, specifications[]{name, values[]}, colours[], sizes[], variant_ids[], sold_by, product_channel, vendors[]{id, name}, seller{id, name} (Marketplace), supplier{id, name} (BIG W range), categories[]{id, name, url}, category_paths[][], collections[]{id, name}, classifications[], identifiers{article_id, gtin, ean, mpn, barcodes[]{barcode, type, is_primary}}, listing_status, lifecycle_status, condition, max_quantity, is_deliverable, is_collectable, has_limited_free_shipping, has_button_cell_battery, is_recalled, online_from, approved_at, payment_options{afterpay, zip, layby}, fulfilment{home_delivery_standard, home_delivery_express, home_delivery_priority, delivery_min_fee_aud, pickup, layby, preorder, drop_ship, logistic_type, colours_in_stock, sizes_in_stock}}, facets[]{filter, label, type, min, max, values[]{value, count}}, suggestions[], redirect_url, query_categorization[], sponsored[]

**Example request body:**
```json
{
  "query": "lego"
}
```

### POST https://api.reefapi.com/bigw/v1/stores — 0 credits
The BIG W store directory (178 stores): address, phone, coordinates, this week's and next weeks' opening hours, services (pick up, direct to boot, layby, bike build…); filter by state or a name / suburb / postcode text, or sort by distance from a point.

**Parameters:**
- `state` (string, optional) — NSW, VIC, QLD, WA, SA, TAS, ACT or NT.
- `query` (string, optional) — Text in the store name, suburb, street or postcode.
- `latitude` (number, optional) — With longitude: sort by distance from this point (km in `distance_km`).
- `longitude` (number, optional) — With latitude.

**Returns:** count, stores[]{id, name, url, phone, address{street, suburb, state, postcode}, latitude, longitude, opening_hours{monday..sunday}, trading_hours_weeks[], services[], distance_km}

**Example request body:**
```json
{
  "state": "NSW"
}
```

### POST https://api.reefapi.com/bigw/v1/store — 0 credits
One BIG W store: address, phone, coordinates, opening hours by week, services.

**Parameters:**
- `store` (string, required) — Store id (`0130`) or a bigw.com.au/store link.

**Returns:** id, name, url, phone, address{street, suburb, state, postcode}, latitude, longitude, opening_hours, trading_hours_weeks[], services[]

**Example request body:**
```json
{
  "store": "0130"
}
```

### POST https://api.reefapi.com/bigw/v1/seller — 1 credit
A Marketplace seller's record: name, dispatch speed, delivery days, return days, rating, badge, terms, shipping and profile text as the seller published them.

**Parameters:**
- `seller` (string, required) — Marketplace seller id `IMP-<uuid>` (cross-border sellers: `IMP-CBT-<uuid>`) — the `seller.id` of a search row or product.

**Returns:** id, name, channel, type, active, fast_dispatch, min_days_to_delivery, max_days_to_delivery, return_days, rating, badge, profile_description, terms_and_conditions, shipping_details, care_and_sizing, message, created_at, updated_at

**Example request body:**
```json
{
  "seller": "IMP-c7ba9a6a-7d7c-321c-9db2-3836b6c7119f"
}
```

## At scale
- **Volume:** 5M+ requests a day, measured at 60 requests a second across the fleet with no
  central bottleneck. Per-key limits are raised for high-volume accounts; volume pricing on request.
- **Missing a source:** tell us a site we do not cover and it becomes an engine. A customer asked
  for bestprice.gr on 21 Sep 2026 and it was in the catalog on 22 Sep.
- **Support:** 2 minute median time from a question in the live chat to the first answer. Setup
  help included, no support tier to buy.
- **One key, one credit pool** across every API. No per-site plans, no separate subscriptions.

## More
- Try it live, no code: https://reefapi.com/playground?engine=bigw
- Human docs page: https://reefapi.com/docs/bigw
- Overview page: https://reefapi.com/bigw-api
- Every ReefAPI API in one file (for your AI): https://reefapi.com/llms-full.txt
