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

Sweetwater Search API Documentation

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

Sweetwater Search API Documentation Search the public Sweetwater music gear catalogue by query, category, brand, sort, price range and zero-based page. Prices are numbers in USD, discount uses multiple signals, ids work unchanged in the next route, dates use ISO 8601 and images are full-size URLs. Availability carries a derived boolean in_stock, or null when stock is unknown; a negative stock count is reported as zero. 1 credit per request. Failed requests are never billed.

Sweetwater Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/sweetwater/search
Auth header
x-api-key
Cost
1 credit / request
Response preview
200 OK
{
    "data": {
        "hits": [
            {
                "url": "/store/detail/SM7B--shure-sm7b",
                "brand": "Shure",
                "image": {
                    "pathAbsolute": "https://media.sweetwater.com/api/i/q-82__ha-abc__w-1500__ca-1/image.jpg"
                },
                "price": {
                    "currency": "USD",
                    "finalPrice": 399,
                    "retailPrice": 449
                },
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

8 optional filters available.

query string Optional

Search text, e.g. sm7b

Example value coffee shops
category string Optional

Category name from a search hit

Example value example
brand string Optional

Brand name from a search hit

Example value example
sort string Optional

price_asc, price_desc, rating_desc, popularitySerials_desc or daysSinceNew_asc

Example value relevance
price_min number Optional

Minimum final price in USD

Example value 10
price_max number Optional

Maximum final price in USD

Example value 10
page integer Optional

Zero-based page number, default 0

Example value 1
hitsPerPage integer Optional

Results per page, default 42, max 300

Example value 10

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": {
        "hits": [
            {
                "url": "/store/detail/SM7B--shure-sm7b",
                "brand": "Shure",
                "image": {
                    "pathAbsolute": "https://media.sweetwater.com/api/i/q-82__ha-abc__w-1500__ca-1/image.jpg"
                },
                "price": {
                    "currency": "USD",
                    "finalPrice": 399,
                    "retailPrice": 449
                },
                "rating": {
                    "count": 1234,
                    "average": 4.8
                },
                "discount": {
                    "amount": 50,
                    "percent": 11.1,
                    "final_price": 399,
                    "is_discounted": true,
                    "original_price": 449
                },
                "objectID": "SM7B",
                "attributes": {
                    "inStock": true,
                    "available": true
                },
                "categories": {
                    "lvl0": [
                        "Microphones"
                    ]
                },
                "genericName": "Microphone",
                "productName": "Shure SM7B",
                "availability": {
                    "in_stock": true
                }
            }
        ],
        "page": 0,
        "query": "sm7b",
        "facets": {
            "brand": {
                "Shure": 25
            }
        },
        "nbHits": 25,
        "nbPages": 1,
        "hitsPerPage": 42
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "algolia_search"
    },
    "success": true
}

Errors

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

422

Validation Error

A query parameter is missing or invalid. Failed requests are not billed.

503

Upstream Unavailable

The upstream source is temporarily unavailable. Failed requests are not billed.

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.