Skip to main content
POST
SERP Simulator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioTitle
string

Page title

ioDescription
string

Meta description

ioUrl
string

Page URL

ioQuery
string

Search query

ioDevice
enum<string>

Device

Available options:
desktop,
mobile
ioSiteName
string

Site name

ioFavicon
boolean

Show favicon

ioDate
string

Date prefix

ioRating
boolean

Show star rating

ioRatingValue
number

Rating

Required range: 0 <= x <= 5
ioRatingCount
number

Review count

ioDescriptionLimit
number

Description character limit

Required range: 80 <= x <= 350

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.