SerpBase

API reference · Web scraping

User-Agent Generator

Generate desktop or mobile user-agent strings using user_agent_type and user_agent_count (1–5). This local operation still has a catalog request price.

POSThttps://api.serpbase.dev/web/user-agent
1 creditOpen in Playground

Example

BASH
curl -X POST 'https://api.serpbase.dev/web/user-agent' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  --max-time 60 \
  -d '{"user_agent_count":1,"user_agent_type":"desktop"}'
Response · real, shortened
{
  "status": 0,
  "credits_charged": 1,
  "request_id": "r-4b27fe8a36d9ac303a5da7dd",
  "product_id": "web_user_agent",
  "action": "user_agent",
  "source": "web",
  "user_agents": [
    "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:123.0) Gecko/20100101 Firefox/123.0"
  ]
}

Parameters

format
"json" | "markdown"
json (default) returns the parsed result.
More

markdown returns the same result as Markdown text (text/markdown) for language models: no envelope, no duplicate alias fields, no inline images. Same credits; failures keep the JSON envelope.

user_agent_count
number
Example: 1
user_agent_type
string
Example: "desktop"
country
string
Public alias for locale.country.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

cursor
string
Public alias for pagination.cursor.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

device
string
Public alias for options.device.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

gl
string
Public alias for locale.country.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

hl
string
Public alias for locale.language.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

html
boolean
Public alias for include_html.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

language
string
Public alias for locale.language.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

limit
integer
Public alias for pagination.limit.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

markdown
boolean
Public alias for include_markdown.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

mobile
boolean
Public alias for options.device.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

num
integer
Public alias for pagination.limit.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

page
integer
Public alias for pagination.page.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

q
string
Public alias for query.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

uanum
integer
Public alias for user_agent_count.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

uatype
string
Public alias for user_agent_type.
More

Use one spelling at a time; the API validates the parameters and values supported by this product.

The sample shows example parameters, not the complete request contract. Known fields are validated by the API; additional parameters are allowed.

What comes back

The fields are those in the response above; every endpoint also carries status, credits_charged and request_id.

If it fails

A failed request has a non-zero status and an error, and is not charged. The ones you will see here:

1000A parameter is missing or wrongFix the request
1020No credits leftTop up
1029Over your requests per secondWait Retry-After seconds
1502 · 1504The source could not be read this timeRetry
All status codes →