---
title: "Browse a SparkFun category"
method: GET
path: "/sparkfun/category"
tags: ["SparkFun"]
---

# Browse a SparkFun category

`GET /sparkfun/category`

## Request

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

Returns paginated public products and dynamic facet filters for a SparkFun category URL key. Each filter must be `attribute:value`; use values from the response's filters array.

## Query parameters

- `url_key` string, required
- `page` integer
- `per_page` integer
- `filter` string[]

## Headers

- `x-api-key` string, required

## Response `200`

OK

- SparkfunCategoryResponseDoc
  - `code` integer
  - `data` SparkfunCategoryResponse
    - `category` SparkfunCategory
      - `id` string
      - `name` string
      - `url_key` string
      - `url_path` string
    - `filters` SparkfunFilter[]
      - `attribute` string
      - `label` string
      - `options` SparkfunFilterOption[]
        - `count` integer
        - `label` string
        - `value` string
    - `page` integer
    - `per_page` integer
    - `products` SparkfunProduct[]
      - `categories` SparkfunCategory[]
        - `id` string
        - `name` string
        - `url_key` string
        - `url_path` string
      - `description` string
      - `image` SparkfunImage
        - `label` string
        - `url` string
      - `media` SparkfunImage[]
        - `label` string
        - `url` string
      - `name` string
      - `price` SparkfunPrice
        - `currency` string
        - `value` number
      - `recommendations` SparkfunProductRecommendation[]
        - `product` SparkfunProduct (recursive)
        - `relation` string
      - `sku` string
      - `stock_status` string
      - `url` string
    - `total` integer
    - `total_pages` integer
  - `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/028417aa35bb?raw)