HTTP API: Fetch a URL

Sends a GET or POST request to the required public HTTP(S) url from the JSON body. Optional fields configure headers, query parameters, cookies, body, timeout, proxy location, and retries. The target status is returned in data.status; response bodies are strings limited to 10 MiB.

1 credit / requestBilled only on success

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

Public HTTP(S) URL. Private, reserved, link-local, and metadata destinations are rejected.

Formaturi

method?string

HTTP method sent to the target URL.

Default"GET"

Value in

"GET"
"POST"
"PUT"
"PATCH"
"DELETE"
"HEAD"
"OPTIONS"

headers?

Headers sent to the target. Hop-by-hop and proxy-control headers are removed.

Default{}

params?

Query parameters appended to the target URL.

Default{}

cookies?

Caller-managed cookies sent with this stateless request.

Default{}

body?string

String request body for POST requests, up to 10 MiB.

timeout_ms?integer

Total request timeout in milliseconds.

Range1000 <= value <= 60000

Default30000

proxy_tier?string

Managed proxy tier. Direct/no-proxy requests are not available.

Default"datacenter"

Value in

"datacenter"
"residential"

country?string

Optional uppercase ISO-2 proxy country.

Match^[A-Z]{2}$

city?string

Optional lowercase proxy city, with spaces written as dots.

Match^[a-z0-9]+(?:[.-][a-z0-9]+)*$

Length1 <= length <= 100

retries?integer

Retries for blocked or retryable transport failures.

Range0 <= value <= 3

Default1

retry_on_5xx?boolean

Retry transient Cloudflare 502/503/504 responses.

Defaultfalse

browser_profile?string

Pin the browser identity (TLS fingerprint and header profile). Omit to let retries rotate through the profiles automatically, which is what clears most challenges.

Value in

"chrome"
"firefox"
"safari"
"edge"

session_id?string

Reuse cookies and a pinned proxy exit across calls, for multi-step flows. Scoped to your own namespace; omit for a stateless request.

Match^[A-Za-z0-9_-]{1,64}$

session_ttl?integer

Seconds a session survives without use. Ignored without session_id.

Range60 <= value <= 7200

reset_session?boolean

Discard the stored session before this call. Ignored without session_id.

Defaultfalse

curl -X POST "https://example.com/v1/http/fetch" \  -H "x-api-key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/products?page=1"  }'

{  "data": {    "status": 200,    "headers": {      "property1": "string",      "property2": "string"    },    "cookies": {      "property1": "string",      "property2": "string"    },    "body": "string",    "body_truncated": false,    "meta": {      "duration_ms": 842.17,      "retried": false,      "browser_profile": "firefox",      "blocked": false,      "session_state": "none",      "cookies_updated": false    }  }}