Skip to content

Build a tags payload

POST
/tags
curl --request POST \
--url https://dd.antibotapi.com/tags \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "type": "ch", "cid": "<your current datadome cookie>", "site_key": "<the site'\''s ddk>", "referer": "https://www.example.com/product/123", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/146.0.0.0 Safari/537.36", "language": "en-GB", "ip_address": "203.0.113.7" }'

Builds the tags.js payload. Call it with type: ch first, submit that payload, then call it with type: le using the datadome cookie the ch submission returned.

x-signature
string

A request signature. Required only when signing is on for your key. See Authentication.

Media typeapplication/json
object
type
required

ch first, then le.

string
Allowed values: ch le
cid
required

Your current datadome cookie. For le, the cookie the ch submission returned.

string
site_key
required

The site’s DataDome key (ddk).

string
referer
required

The last URL visited, not percent-encoded.

string
user_agent
required

The User-Agent for the session.

string
language
required

The first tag of your Accept-Language header.

string
ip_address
required

Your proxy’s exit IP. Sets the payload’s timezone.

string

Example

{
"type": "ch",
"cid": "<your current datadome cookie>",
"site_key": "<the site's ddk>",
"referer": "https://www.example.com/product/123",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/146.0.0.0 Safari/537.36",
"language": "en-GB",
"ip_address": "203.0.113.7"
}

Payload built.

Media typeapplication/json
object
success
required
boolean
payload
required

The form body to POST to the site’s tags endpoint (usually the URL ending in /js/), unchanged.

string

Example generated

{
"success": true,
"payload": "example"
}

The request is invalid, or the solve failed for a reason you can fix. error says why. Not billed.

Media typeapplication/json
object
success
required
boolean
error
required

What went wrong.

string

Example

{
"success": false
}

The API key is missing, unknown, revoked or out of balance.

Media typeapplication/json
object
success
required
boolean
error
required

What went wrong.

string

Example

{
"success": false,
"error": "x-api-key is required"
}

The site is not approved for your account. Request it from the dashboard.

Media typeapplication/json
object
success
required
boolean
error
required

What went wrong.

string

Example

{
"success": false,
"error": "site is not whitelisted for this service"
}

Something failed on our side. Retry once. Not billed.

Media typeapplication/json
object
success
required
boolean
error
required

What went wrong.

string

Example

{
"success": false
}