SparkFun API endpoint
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.
/sparkfun/categoryReturns public products and dynamic facets for one SparkFun category.
Query parameters:
url_key (required) — SparkFun category URL key, for example development-boards.page (optional) — 1-indexed result page. Defaults to 1; allowed values are 1 through 100.per_page (optional) — products per page. Defaults to 24; allowed values are 1 through 24.filter (optional, repeatable) — a dynamic facet in attribute:value form. Use values returned in filters[]; they are not a fixed enum.Notable response behavior: an unknown category returns 404. filters[] is category-specific and supports follow-up filtered requests.
| Field | Filled in, of 24 checked | Values in the sample |
|---|---|---|
| sku | 24 | |
| name | 24 | “SparkFun Roller Encoder Breakout” and 23 other values |
| url | 24 | sparkfun.com |
| stock_status | 24 | IN_STOCK in all 24 |
| price | 24 | |
| image | 24 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| url_key | string | Yes | SparkFun category URL key | development-boards | |
| page | integer | No | One-based result page (1-100) Minimum: 1. Maximum: 100. | ||
| per_page | integer | No | Products per page (1-24) Minimum: 1. Maximum: 24. | ||
| filter | array<string> | No | Repeatable dynamic facet in attribute:value form Repeat this query parameter for multiple values. | sf_qwiic_dev_board_type:8417 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/sparkfun/category?url_key=development-boards&page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"category": {
"id": "MTAwMw==",
"name": "Development Boards",
"url_key": "development-boards",
"url_path": "development-boards"
},
"page": 1,
"per_page": 24,
"total": 617,
"total_pages": 26,
"products": [
{
"sku": "DEV-18158",
"name": "SparkFun RedBoard Plus"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/sparkfun.categoryResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | sparkfun.CategoryResponse | No | ||||
| data.category | sparkfun.Category | No | Category record, 4 fields: id, name, url_key, url_path. Described under SparkFun Product API. | |||
| data.filters | array | No | Filter record, 6 fields: attribute, label, options. Described under SparkFun Product Search API. | |||
| data.page | integer | No | ||||
| data.per_page | integer | No | ||||
| data.products | array | No | Product record, 22 fields: categories, description, image, media, name, price, recommendations, sku, stock_status, url. Described under SparkFun Product API. | |||
| data.total | integer | No | ||||
| data.total_pages | integer | No | ||||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/sparkfun/category?url_key=development-boards&page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"