Skip to content
Scrappa Get API key
IKEA API 1 credit/request

IKEA Search API Documentation

GET https://scrappa.co/api/ikea/search

IKEA Search API returns 24 products per page for a keyword or an 8 digit item number: name, type, size, price with previous price and offer, rating, images with alt text, colour variants, category path and availability. Sort with sort and page with page. The answer carries the total and the sort options.

Choose the country with country (us, de, gb, fr, ca, au). Send a store_id from the stores route to add store availability to each product. A page that is not the requested page, or a sort that IKEA did not apply, is never returned. A successful request costs 1 credit.

IKEA Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/ikea/search
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "page": 2,
        "sort": "PRICE_LOW_TO_HIGH",
        "items": [
            {
                "url": "https://www.ikea.com/us/en/p/fjaederharv-mini-chest-with-2-drawers-anthracite-00596892/",
                "name": "FJ\u00c4DERHARV",
                "type": "Mini chest with 2 drawers",
                "price": {
                    "tags": [],
                    "offer": null,
                    "amount": 19.99,
                    "currency": "USD",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

4 optional filters available.

query string Required

Search keyword or 8 digit item number.

Example value coffee shops
page integer Optional

One-based page number, 1 to 100 (default 1).

Example value 1
country string Optional

Country: us (default), de, gb, fr, ca or au.

Example value US
sort string Optional

RELEVANCE (default), PRICE_LOW_TO_HIGH, PRICE_HIGH_TO_LOW, NEWEST, RATING, NAME_ASCENDING or MOST_POPULAR.

Example value relevance
store_id string Optional

Store id from the stores route. Adds store availability to each product.

Example value 1234567890

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "page": 2,
        "sort": "PRICE_LOW_TO_HIGH",
        "items": [
            {
                "url": "https://www.ikea.com/us/en/p/fjaederharv-mini-chest-with-2-drawers-anthracite-00596892/",
                "name": "FJ\u00c4DERHARV",
                "type": "Mini chest with 2 drawers",
                "price": {
                    "tags": [],
                    "offer": null,
                    "amount": 19.99,
                    "currency": "USD",
                    "previous_amount": null
                },
                "colors": [
                    "gray"
                ],
                "images": [
                    {
                        "alt": "Black FJ\u00c4DERHARV mini chest with 2 drawers, made of recycled paperboard, rectangular shape, simple design.",
                        "url": "https://www.ikea.com/us/en/images/products/fjaederharv-mini-chest-with-2-drawers-anthracite__1396163_pe967189_s5.jpg",
                        "type": "MAIN_PRODUCT_IMAGE"
                    },
                    {
                        "alt": "FJ\u00c4DERHARV Mini chest with 2 drawers, anthracite, 12 \u00bdx9 \u00be \"",
                        "url": "https://www.ikea.com/us/en/images/products/fjaederharv-mini-chest-with-2-drawers-anthracite__1444159_pe987409_s5.jpg",
                        "type": "CONTEXT_PRODUCT_IMAGE"
                    }
                ],
                "rating": 3.6,
                "variants": [
                    {
                        "url": "https://www.ikea.com/us/en/p/fjaederharv-mini-chest-with-2-drawers-white-10596896/",
                        "rating": 3.6,
                        "image_url": "https://www.ikea.com/us/en/images/products/fjaederharv-mini-chest-with-2-drawers-white__1396172_pe967197_s5.jpg",
                        "item_number": "10596896",
                        "rating_count": 298
                    }
                ],
                "image_url": "https://www.ikea.com/us/en/images/products/fjaederharv-mini-chest-with-2-drawers-anthracite__1396163_pe967189_s5.jpg",
                "item_type": "ART",
                "size_text": "12 \u00bdx9 \u00be \"",
                "categories": [
                    "Storage containers, organizers & baskets",
                    "Paper & media organizers",
                    "Paper & media storage boxes"
                ],
                "design_text": "anthracite",
                "item_number": "00596892",
                "last_chance": false,
                "availability": [
                    {
                        "text": "In stock in Pittsburgh, PA",
                        "store": "Pittsburgh, PA",
                        "status": "HIGH_IN_STOCK",
                        "channel": "CASH_AND_CARRY"
                    }
                ],
                "rating_count": 298,
                "online_sellable": true,
                "item_number_global": "00596892"
            },
            {
                "url": "https://www.ikea.com/us/en/p/kuggis-magazine-file-white-10515334/",
                "name": "KUGGIS",
                "type": "Magazine file",
                "price": {
                    "tags": [],
                    "offer": null,
                    "amount": 19.99,
                    "currency": "USD",
                    "previous_amount": null
                },
                "colors": [
                    "white"
                ],
                "images": [
                    {
                        "alt": "Two white KUGGIS magazine holders made of pet plastic, standing upright, one displaying a side view, showcasing the cut-out opening for easy access.",
                        "url": "https://www.ikea.com/us/en/images/products/kuggis-magazine-file-white__1074639_pe856242_s5.jpg",
                        "type": "MAIN_PRODUCT_IMAGE"
                    },
                    {
                        "alt": "Two wall-mounted shelves holding magazine holders, books, and a plant.",
                        "url": "https://www.ikea.com/us/en/images/products/kuggis-magazine-file-white__1074637_pe856240_s5.jpg",
                        "type": "FUNCTIONAL_PRODUCT_IMAGE"
                    }
                ],
                "rating": 4.5,
                "variants": [],
                "image_url": "https://www.ikea.com/us/en/images/products/kuggis-magazine-file-white__1074639_pe856242_s5.jpg",
                "item_type": "ART",
                "size_text": "",
                "categories": [
                    "Storage containers, organizers & baskets",
                    "Paper & media organizers",
                    "Magazine files"
                ],
                "design_text": "white",
                "item_number": "10515334",
                "last_chance": false,
                "availability": [
                    {
                        "text": "In stock in Pittsburgh, PA",
                        "store": "Pittsburgh, PA",
                        "status": "HIGH_IN_STOCK",
                        "channel": "CASH_AND_CARRY"
                    }
                ],
                "rating_count": 259,
                "online_sellable": true,
                "item_number_global": "10515334"
            }
        ],
        "query": "billy",
        "total": 115,
        "country": "us",
        "filters": [
            {
                "id": "MEASUREMENT_BUCKETS",
                "name": "Size"
            },
            {
                "id": "COLOR",
                "name": "Color"
            }
        ],
        "store_id": "153",
        "page_size": 24,
        "total_pages": 5,
        "sort_options": [
            {
                "id": "RELEVANCE",
                "name": "Best match",
                "selected": false
            },
            {
                "id": "PRICE_LOW_TO_HIGH",
                "name": "Price: low to high",
                "selected": true
            },
            {
                "id": "PRICE_HIGH_TO_LOW",
                "name": "Price: high to low",
                "selected": false
            }
        ]
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

The item does not exist in the chosen country. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "product"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
422

Validation Error

A parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "sort": [
            "The sort must be one of RELEVANCE, PRICE_LOW_TO_HIGH, PRICE_HIGH_TO_LOW, NEWEST, RATING, NAME_ASCENDING, MOST_POPULAR."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

IKEA could not be reached, or it returned data that does not match the request (another page, another sort). This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "IKEA could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.