Docs menu

SparkFun API endpoint

SparkFun Product Search API

Searches public SparkFun product data with pagination and dynamic facet filters. Each filter must be `attribute:value`; use values from the response's filters array.

GETapiKey1 credit/requestSparkFunsparkfun.searchResponseDoc/sparkfun/search

Endpoint facts

Method: GET
API path: /sparkfun/search
Auth: apiKey
Credits: 1 credit/request
Charged on: Successful 2xx responses only
Platform: SparkFun
Execution: Managed browser rendering where the target needs it
Response schema: #/definitions/sparkfun.searchResponseDoc

SparkFun API Try SparkFun Product Search API in Playground SparkFun API documentation

How this endpoint behaves

Searches public SparkFun products and returns dynamic filters that can narrow subsequent searches.

Query parameters:

q (required) — product search text, 2 to 200 characters, for example arduino.
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, for example sf_qwiic_dev_board_type:8417. Use attribute and value pairs returned in filters[]; they are not a fixed enum.

Notable response behavior: total: 0 is a valid no-results response. filters[] contains the currently available attributes and values for the search.

Live monitoring

Monitored request: GET /sparkfun/search?per_page=3&q=arduino
Checks passed, 7 days to 14 Oct 2026: 100%
Median response time: 0.93 s

Current status of every endpoint

Sampled response

Request, 14 Oct 2026: GET /sparkfun/search?per_page=24&q=arduino
Items in products: 24
Fields filled in every checked item: 6

Field	Filled in, of 24 checked	Values in the sample
sku	24
name	24	“Arduino Uno - R3” and 23 other values
url	24	sparkfun.com
stock_status	24	IN_STOCK in all 24
price	24
image	24

Request parameters

Parameter	Type	Required	Description	Example
q	string	Yes	Product search query	arduino
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 example

curl -X GET "https://api.crawlora.net/api/v1/sparkfun/search?q=arduino&page=1" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "query": "arduino",
    "page": 1,
    "per_page": 24,
    "total": 470,
    "total_pages": 20,
    "products": [
      {
        "sku": "DEV-10116",
        "name": "Arduino Fio",
        "stock_status": "IN_STOCK"
      }
    ],
    "filters": [
      {
        "attribute": "price",
        "label": "Price",
        "options": [
          {
            "label": "0-5",
            "value": "0_5",
            "count": 56
          }
        ]
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/sparkfun.searchResponseDoc

Field	Type	Required	Example	Description
code	integer	No	200
data	sparkfun.SearchResponse	No
data.filters	array	No
data.filters[].attribute	string	No
data.filters[].label	string	No
data.filters[].options	array	No
data.filters[].options[].count	integer	No
data.filters[].options[].label	string	No
data.filters[].options[].value	string	No
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.query	string	No
data.total	integer	No
data.total_pages	integer	No
msg	string	No	OK

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/sparkfun/search?q=arduino&page=1" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing Acceptable use

More SparkFun endpoint docs SparkFun API SparkFun Categories API documentation SparkFun Category Browse API documentation SparkFun Product API documentation

Open in Playground Back to group

Docs menu

SparkFun API endpoint

SparkFun Product Search API

Searches public SparkFun product data with pagination and dynamic facet filters. Each filter must be `attribute:value`; use values from the response's filters array.

GETapiKey1 credit/requestSparkFunsparkfun.searchResponseDoc/sparkfun/search

Endpoint facts

Method: GET
API path: /sparkfun/search
Auth: apiKey
Credits: 1 credit/request
Charged on: Successful 2xx responses only
Platform: SparkFun
Execution: Managed browser rendering where the target needs it
Response schema: #/definitions/sparkfun.searchResponseDoc

SparkFun API Try SparkFun Product Search API in Playground SparkFun API documentation

How this endpoint behaves

Searches public SparkFun products and returns dynamic filters that can narrow subsequent searches.

Query parameters:

q (required) — product search text, 2 to 200 characters, for example arduino.
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, for example sf_qwiic_dev_board_type:8417. Use attribute and value pairs returned in filters[]; they are not a fixed enum.

Notable response behavior: total: 0 is a valid no-results response. filters[] contains the currently available attributes and values for the search.

Live monitoring

Monitored request: GET /sparkfun/search?per_page=3&q=arduino
Checks passed, 7 days to 14 Oct 2026: 100%
Median response time: 0.93 s

Current status of every endpoint

Sampled response

Request, 14 Oct 2026: GET /sparkfun/search?per_page=24&q=arduino
Items in products: 24
Fields filled in every checked item: 6

Field	Filled in, of 24 checked	Values in the sample
sku	24
name	24	“Arduino Uno - R3” and 23 other values
url	24	sparkfun.com
stock_status	24	IN_STOCK in all 24
price	24
image	24

Request parameters

Parameter	Type	Required	Description	Example
q	string	Yes	Product search query	arduino
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 example

curl -X GET "https://api.crawlora.net/api/v1/sparkfun/search?q=arduino&page=1" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "query": "arduino",
    "page": 1,
    "per_page": 24,
    "total": 470,
    "total_pages": 20,
    "products": [
      {
        "sku": "DEV-10116",
        "name": "Arduino Fio",
        "stock_status": "IN_STOCK"
      }
    ],
    "filters": [
      {
        "attribute": "price",
        "label": "Price",
        "options": [
          {
            "label": "0-5",
            "value": "0_5",
            "count": 56
          }
        ]
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/sparkfun.searchResponseDoc

Field	Type	Required	Example	Description
code	integer	No	200
data	sparkfun.SearchResponse	No
data.filters	array	No
data.filters[].attribute	string	No
data.filters[].label	string	No
data.filters[].options	array	No
data.filters[].options[].count	integer	No
data.filters[].options[].label	string	No
data.filters[].options[].value	string	No
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.query	string	No
data.total	integer	No
data.total_pages	integer	No
msg	string	No	OK

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/sparkfun/search?q=arduino&page=1" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing Acceptable use

More SparkFun endpoint docs SparkFun API SparkFun Categories API documentation SparkFun Category Browse API documentation SparkFun Product API documentation

Open in Playground Back to group

SparkFun Product Search API

Endpoint facts

How this endpoint behaves

Live monitoring

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related

SparkFun Product Search API

Endpoint facts

How this endpoint behaves

Live monitoring

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related