> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mindcase.co/llms.txt
> Use this file to discover all available pages before exploring further.

# IKEA Products API

> Extract IKEA products from any country: article number, name and type, current and previous price, rating, colour, measurements, category, variants and national plus per-store stock

`POST /v1/data/ikea/products/run`

**Pricing:** $0.0045 per product ($4.50 per 1,000).

## Ways to call it

* **URL**: set `urls` (optional: `sortBy`, `maxResults`)
* **Keyword**: set `queries` (optional: `country`, `sortBy`, `maxResults`)

## Request

Send the inputs under `params`. Only the keys below are accepted; any other key returns `422 invalid_params`.

**urls** `string[]`

IKEA product, category or search links ([https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/](https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/)). Each link uses its own country and language. One per line; room, offers and store pages are not supported.

**queries** `string[]`

Words to search IKEA for, one per line (billy bookcase, desk lamp). For links, use URLs instead.

**country** `string` (default: us)

By Keyword only. The IKEA country to search; it sets prices, currency, product range and the language of the text. United States by default. Links always use their own country.

39 allowed values, for example `us` (United States), `gb` (United Kingdom), `ca` (Canada), `au` (Australia), `in` (India), `sg` (Singapore), `jp` (Japan), `kr` (South Korea), `cn` (China), `th` (Thailand). Fetch the full list with `GET /v1/data/ikea/products?expand=options`.

**sortBy** `string` (default: relevance)

The order products are listed in for a search or category before Max Results is applied. Most relevant first by default. Has no effect on single product links.

Allowed values: `relevance` (Most relevant), `priceLowToHigh` (Price, low to high).

**maxResults** `integer` (default: 100)

How many products to return in total. Defaults to 100; use 0 for all.

## Example

```bash cURL theme={null}
curl -X POST "https://api.mindcase.co/v1/data/ikea/products/run?wait=true" \
  -H "Authorization: Bearer $MINDCASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "params": {
    "urls": [
      "https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/",
      "https://www.ikea.com/de/de/p/kallax-regal-weiss-80275887/",
      "https://www.ikea.com/us/en/cat/bookcases-10382/"
    ],
    "maxResults": 10
  }
}'
```

```python Python theme={null}
import os, requests

r = requests.post(
    "https://api.mindcase.co/v1/data/ikea/products/run",
    params={"wait": "true"},
    headers={"Authorization": f"Bearer {os.environ['MINDCASE_API_KEY']}"},
    json={"params": {
    "urls": [
        "https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/",
        "https://www.ikea.com/de/de/p/kallax-regal-weiss-80275887/",
        "https://www.ikea.com/us/en/cat/bookcases-10382/"
    ],
    "maxResults": 10
}},
)
job = r.json()
rows = job.get("data", [])  # if job["status"] == "running", poll /v1/jobs/{job_id}/results
```

```javascript Node.js theme={null}
const r = await fetch("https://api.mindcase.co/v1/data/ikea/products/run?wait=true", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MINDCASE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ params: {
  "urls": [
    "https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/",
    "https://www.ikea.com/de/de/p/kallax-regal-weiss-80275887/",
    "https://www.ikea.com/us/en/cat/bookcases-10382/"
  ],
  "maxResults": 10
} }),
});
const job = await r.json();
const rows = job.data ?? []; // if job.status === "running", poll /v1/jobs/{job_id}/results
```

## Response fields

Each row in `data` is one product, keyed by these fields.

| Field | Name | Type |
| - | - | - |
| `productUrl` | Product URL | url |
| `productId` | Product ID | text |
| `productName` | Product Name | text |
| `productType` | Product Type | text |
| `country` | Country | text |
| `price` | Price | number |
| `currency` | Currency | text |
| `listPrice` | List Price | number |
| `onSale` | On Sale | boolean |
| `priceTag` | Price Tag | text |
| `rating` | Rating | rating |
| `ratingCount` | Rating Count | number |
| `inStock` | In Stock | boolean |
| `onlineSellable` | Online Sellable | boolean |
| `color` | Color | text |
| `measurements` | Measurements | text |
| `categoryPath` | Category Path | text |
| `badge` | Badge | text |
| `isNewArrival` | Is New Arrival | boolean |
| `lastChance` | Last Chance | boolean |
| `variantCount` | Variant Count | integer |
| `mainImage` | Main Image | url |
| `images` | Images | array |
| `variants` | Variants | object\_array |
| `availability` | Availability | object |

## Example response

Abridged: long text and lists are shortened.

```json theme={null}
{
  "job_id": "7f3a1c2e-0b9d-4c55-9a51-3f2e8d1b6a40",
  "agent": "ikea/products",
  "status": "completed",
  "row_count": 1,
  "truncated": false,
  "data": [
    {
      "rating": 4.5,
      "variantCount": 4,
      "productId": "20522046",
      "productType": "Bookcase",
      "variants": [
        {
          "id": "50508652",
          "name": "BILLY",
          "url": "https://www.ikea.com/us/en/p/billy-bookcase-brown-walnut-effect-50508652/",
          "image": "https://www.ikea.com/us/en/images/products/billy-bookcase-brown-walnut-effect__1590308_pe1038947_s5.jpg",
          "color": "brown walnut effect",
          "price": 89,
          "currency": "USD",
          "ratingValue": 4.5,
          "ratingCount": 2119
        },
        {
          "id": "40477340",
          "name": "BILLY",
          "url": "https://www.ikea.com/us/en/p/billy-bookcase-black-oak-effect-40477340/",
          "image": "https://www.ikea.com/us/en/images/products/billy-bookcase-black-oak-effect__1590300_pe1038939_s5.jpg",
          "color": "black oak effect",
          "price": 89,
          "currency": "USD",
          "ratingValue": 4.5,
          "ratingCount": 2119
        }
      ],
      "lastChance": false,
      "images": [
        "https://www.ikea.com/us/en/images/products/billy-bookcase-white__1590272_pe1038911_s5.jpg",
        "https://www.ikea.com/us/en/images/products/billy-bookcase-white__1237507_pe917999_s5.jpg"
      ],
      "priceTag": null,
      "availability": {
        "national": {
          "country": "US",
          "clickCollect": true,
          "homeDelivery": true,
          "clickCollectInRange": true,
          "homeDeliveryInRange": true,
          "stockStatus": "HIGH_IN_STOCK"
        },
        "storesWithStock": 57,
        "stores": [
          {
            "code": "064",
            "cashCarry": true,
            "clickCollect": true,
            "homeDelivery": false,
            "quantity": 480,
            "stockStatus": "HIGH_IN_STOCK"
          },
          {
            "code": "157",
            "cashCarry": true,
            "clickCollect": true,
            "homeDelivery": false,
            "quantity": 412,
            "stockStatus": "HIGH_IN_STOCK"
          },
          {
            "code": "158",
            "cashCarry": true,
            "clickCollect": true,
            "homeDelivery": false,
            "quantity": 411,
            "stockStatus": "HIGH_IN_STOCK"
          }
        ]
      },
      "badge": "Best seller",
      "mainImage": "https://www.ikea.com/us/en/images/products/billy-bookcase-white__1590272_pe1038911_s5.jpg",
      "country": "us",
      "onlineSellable": true,
      "inStock": true,
      "ratingCount": 2119,
      "isNewArrival": false,
      "onSale": false,
      "measurements": "31 1/2x11x79 1/2 \"",
      "categoryPath": "Storage & organization > Shelving furniture > Bookshelves & bookcases",
      "color": "white",
      "productName": "BILLY",
      "productUrl": "https://www.ikea.com/us/en/p/billy-bookcase-white-20522046/",
      "currency": "USD",
      "listPrice": null,
      "price": 79
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.