2extract Developer Documentation

The 2extract Public API gives you programmatic access to everything you can do in the dashboard: create and configure proxies, track usage, manage your balance, and look up geo data - all over HTTPS with JSON.

Interactive Swagger UI

Explore and test every endpoint directly in your browser.

Postman Collection

Import the ready-made collection and start making requests in minutes.

Base URL

All API requests go to:

https://api.2extract.com

Authentication

The API uses API keys passed in a request header. Every request must include:

X-API-Key: 2xt_YOUR_API_KEY

Getting an API key:

Open the Dashboard and go to API Keys in the sidebar.
Click Create API Key and select the permissions you need.
Copy the key - it is shown only once.

API keys are secrets. Do not commit them to version control or expose them in client-side code. Rotate a key immediately if it is ever leaked.

Scopes

Each API key carries one or more scopes that gate access to endpoint groups. Request only the scopes your integration needs.

Scope	Grants access to
`proxies:read`	List and retrieve proxy details
`proxies:write`	Create, update, and delete proxies
`stats:read`	Traffic statistics and usage export
`balance:read`	Account balance and balance history
`geo:read`	Country, state, city, and ZIP lookup

proxies:write does not include proxies:read - the scopes are independent.

Request Format

For endpoints that accept a body (POST, PUT), send JSON and set the Content-Type header:

Content-Type: application/json

Response Format

All responses are JSON wrapped in a standard envelope:

{
  "result": true,
  "data": { ... },
  "error": "",
  "error_type": "",
  "meta": {}
}

Field	Type	Description
`result`	boolean	`true` on success, `false` on error
`data`	object / array	The response payload
`error`	string	Human-readable error message (empty on success)
`error_type`	string	Machine-readable error code (empty on success)
`meta`	object	Pagination or other metadata where applicable

Error Handling

Error responses use standard HTTP status codes alongside the envelope:

{
  "result": false,
  "error": "API key not found or expired",
  "error_type": "unauthorized"
}

HTTP Status	Meaning
`400 Bad Request`	Invalid input - check the request body or query parameters
`401 Unauthorized`	Missing or invalid API key
`403 Forbidden`	Valid key, but insufficient scope for this endpoint
`404 Not Found`	The requested resource does not exist

Quick Example

Retrieve all your proxies with a single curl call:

curl https://api.2extract.com/v1/proxy \
  -H "X-API-Key: 2xt_YOUR_API_KEY"

See the Swagger UI for a full interactive reference of every endpoint, including request schemas and live response examples.

Overview

Endpoints

Public API

Interactive Swagger UI

Postman Collection

Base URL

Authentication

Scopes

Request Format

Response Format

Error Handling

Quick Example

Interactive Swagger UI

Postman Collection

​Base URL

​Authentication

​Scopes

​Request Format

​Response Format

​Error Handling

​Quick Example

Base URL

Authentication

Scopes

Request Format

Response Format

Error Handling

Quick Example