Dolphin Anty Public API

https://docs.dolphin-anty-cdn.com/index.html
Admin
The Dolphin Anty Public API provides programmatic access for automating tasks such as managing...
Tokens:5,320
Snippets:50
Trust Score:5.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Generate Python Client

Source: https://docs.dolphin-anty-cdn.com/index.html

Setup steps to install the generator, download the OpenAPI specification, and generate a Python client.

```bash
pip install openapi-generator-cli
curl -o openapi.yaml http://docs.dolphin-anty-cdn.com/openapi.yaml
openapi-generator generate -i openapi.yaml -g python -o ./python-client
pip install -e ./python-client
```

--------------------------------

### POST /v1.0/browser_profiles/{browserProfileId}/start

Source: https://docs.dolphin-anty-cdn.com/index.html

Starts a local Anty browser instance bound to an existing browser profile.

```APIDOC
## POST /v1.0/browser_profiles/{browserProfileId}/start

### Description
Starts a local Anty browser instance. When automation is enabled, the response returns the DevTools port and wsEndpoint.

### Method
POST

### Endpoint
/v1.0/browser_profiles/{browserProfileId}/start
```

--------------------------------

### Use Python Client

Source: https://docs.dolphin-anty-cdn.com/index.html

Example of configuring the API client and creating a proxy using the generated Python models.

```python
from openapi_client import ApiClient, Configuration
from openapi_client.api import proxies_api
from openapi_client.models import ProxyCreateInput

configuration = Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Bearer'

api_instance = proxies_api.ProxiesApi(api_client=ApiClient(configuration))
proxy_create_input = ProxyCreateInput(
    type="http",
    host="proxy.example.com",
    port=8080,
    login="username",
    password="password"
)

api_instance.create_proxy(proxy_create_input)
```

--------------------------------

### TypeScript openapi-fetch Pattern

Source: https://docs.dolphin-anty-cdn.com/index.html

Installation and usage of openapi-fetch for a zero-codegen approach to API requests.

```bash
npm install openapi-fetch openapi-typescript
```

```typescript
import createClient from 'openapi-fetch';
import type { paths } from './api';

const client = createClient<paths>({
  baseUrl: 'https://dolphin-anty-api.com',
  headers: { Authorization: 'Bearer YOUR_API_KEY' },
});

const { data } = await client.POST('/proxy', { body: proxyCreateInput });
```

--------------------------------

### GET /proxy

Source: https://docs.dolphin-anty-cdn.com/index.html

Retrieves a list of proxies from the Dolphin{anty} API.

```APIDOC
## GET /proxy

### Description
Lists all proxies configured in the system.

### Method
GET

### Endpoint
/proxy
```

--------------------------------

### TypeScript openapi-client-axios Pattern

Source: https://docs.dolphin-anty-cdn.com/index.html

Installation and usage of openapi-client-axios for an Axios-based API client wrapper.

```bash
npm install axios openapi-client-axios openapi-typescript
```

```typescript
import OpenAPIClientAxios from 'openapi-client-axios';
import type { paths } from './api';

const api = new OpenAPIClientAxios<paths>({
  definition: 'http://docs.dolphin-anty-cdn.com/openapi.yaml',
});
const client = await api.init();

await client.createProxy(null, proxyCreateInput);
```

--------------------------------

### GET /browser_profiles/statuses

Source: https://docs.dolphin-anty-cdn.com/index.html

Retrieves a list of all browser profile statuses.

```APIDOC
## GET /browser_profiles/statuses

### Description
Retrieves browser profile statuses.

### Method
GET

### Endpoint
/browser_profiles/statuses
```

--------------------------------

### Create a proxy via cURL

Source: https://docs.dolphin-anty-cdn.com/index.html

Example request to create a new proxy using the POST method with JSON payload.

```shell
curl https://dolphin-anty-api.com/proxy \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "type": "http",
  "host": "",
  "port": 0,
  "login": "",
  "password": "",
  "name": "",
  "changeIpUrl": "",
  "provider": ""
}'
```

--------------------------------

### Retrieve Proxies via cURL

Source: https://docs.dolphin-anty-cdn.com/index.html

Example request for listing proxies with query parameters and Bearer token authentication.

```Shell
curl 'https://dolphin-anty-api.com/proxy?limit=1&query=&sortBy=name&order=ASC&ids=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### GET /proxy

Source: https://docs.dolphin-anty-cdn.com/index.html

Retrieves a paginated list of proxies based on optional filters and sorting criteria.

```APIDOC
## GET /proxy

### Description
Retrieves a paginated list of proxies. Supports filtering by name or host, sorting by various fields, and restricting results by specific IDs.

### Method
GET

### Endpoint
https://dolphin-anty-api.com/proxy

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of items per page (max 100).
- **query** (string) - Optional - Filter proxies by name or host prefix.
- **sortBy** (string) - Optional - Field to sort by (name, status, type, host, browser_profiles_count, created_at, updated_at).
- **order** (string) - Optional - Sort direction (ASC, DESC).
- **ids** (array integer[]) - Optional - Restrict list to the provided ids.

### Request Example
curl 'https://dolphin-anty-api.com/proxy?limit=1&query=&sortBy=name&order=ASC&ids=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

### Response
#### Success Response (200)
- **current_page** (integer) - Current page number
- **data** (array) - List of proxy objects

#### Response Example
{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "type": "http",
      "host": "string",
      "port": 1
    }
  ]
}
```

--------------------------------

### Export cookies via cURL

Source: https://docs.dolphin-anty-cdn.com/index.html

Example request for exporting cookies from a browser profile using the POST method.

```shell
curl https://darkwing.dolphin-anty-api.com/api/v1/cookies/export \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "browserProfileId": 12345
}'
```

--------------------------------

### GET /v1.0/browser_profiles/{browserProfileId}/stop

Source: https://docs.dolphin-anty-cdn.com/index.html

Stops a running browser profile and syncs the data directory back to the cloud.

```APIDOC
## GET /v1.0/browser_profiles/{browserProfileId}/stop

### Description
Stops the specified browser profile and ensures data is synced to the cloud.

### Method
GET

### Endpoint
/v1.0/browser_profiles/{browserProfileId}/stop
```

--------------------------------

### GET /team/users

Source: https://docs.dolphin-anty-cdn.com/index.html

Retrieves a list of team members (API v2).

```APIDOC
## GET /team/users

### Description
Retrieves team members.

### Method
GET

### Endpoint
/team/users
```

--------------------------------

### POST /proxy

Source: https://docs.dolphin-anty-cdn.com/index.html

Creates a new proxy configuration in the system. Requires connection details such as host, port, and protocol type.

```APIDOC
## POST /proxy

### Description
Creates a new proxy entry. The connection to the proxy is established by the application on the user's machine.

### Method
POST

### Endpoint
/proxy

### Parameters
#### Request Body
- **host** (string) - Required - Proxy URL or IPv4/IPv6 address.
- **port** (integer) - Required - Proxy port (0-65535).
- **type** (string) - Required - Proxy protocol type (http, socks4, socks5, ssh).
- **changeIpUrl** (string) - Optional - URL that triggers IP rotation for the proxy.
- **login** (string) - Optional - Username for proxy authentication.
- **name** (string) - Optional - Human-readable alias for the proxy.
- **password** (string) - Optional - Password for proxy authentication.
- **provider** (string) - Optional - Provider identifier if the proxy originates from a supported provider.

### Request Example
{
  "type": "http",
  "host": "",
  "port": 0,
  "login": "",
  "password": "",
  "name": "",
  "changeIpUrl": "",
  "provider": ""
}

### Response
#### Success Response (200)
- **data** (object) - The newly created proxy object containing ID, connection details, and status information.

#### Response Example
{
  "data": {
    "id": 1,
    "teamId": 1,
    "userId": 1,
    "name": null,
    "type": "http",
    "host": "string",
    "port": 1,
    "login": null,
    "password": null,
    "changeIpUrl": null,
    "provider": null,
    "ip": null,
    "savedByUser": true,
    "browser_profiles_count": 1,
    "lastCheck": {
      "createdAt": "2026-08-08T20:21:12.422Z",
      "status": true,
      "ip": "string",
      "country": "string",
      "region": "string",
      "city": "string",
      "timezone": "string",
      "found": 1,
      "total": 1,
      "blacklists": ["string"]
    },
    "createdAt": "2026-08-08T20:21:12.422Z",
    "updatedAt": "2026-08-08T20:21:12.422Z"
  }
}
```

--------------------------------

### POST /team/users

Source: https://docs.dolphin-anty-cdn.com/index.html

Creates a new team member in the system.

```APIDOC
## POST /team/users

### Description
Creates a new team member.

### Method
POST

### Endpoint
/team/users
```

--------------------------------

### Proxy creation response schema

Source: https://docs.dolphin-anty-cdn.com/index.html

The JSON structure returned upon a successful proxy creation request.

```json
{
  "data": {
    "id": 1,
    "teamId": 1,
    "userId": 1,
    "name": null,
    "type": "http",
    "host": "string",
    "port": 1,
    "login": null,
    "password": null,
    "changeIpUrl": null,
    "provider": null,
    "ip": null,
    "savedByUser": true,
    "browser_profiles_count": 1,
    "lastCheck": {
      "createdAt": "2026-08-08T20:21:12.422Z",
      "status": true,
      "ip": "string",
      "country": "string",
      "region": "string",
      "city": "string",
      "timezone": "string",
      "found": 1,
      "total": 1,
      "blacklists": [
        "string"
      ]
    },
    "createdAt": "2026-08-08T20:21:12.422Z",
    "updatedAt": "2026-08-08T20:21:12.422Z"
  }
}
```

--------------------------------

### Generate TypeScript Static Types

Source: https://docs.dolphin-anty-cdn.com/index.html

Command to generate static TypeScript definitions from the OpenAPI specification.

```bash
npx openapi-typescript openapi.yaml -o src/api.d.ts
```

--------------------------------

### POST /cookies/import

Source: https://docs.dolphin-anty-cdn.com/index.html

Imports cookies into a specified browser profile remotely. Requires a paid plan and cloud sync to be enabled on the target profile.

```APIDOC
## POST /cookies/import

### Description
Imports cookies into the specified browser profile remotely. Existing cookies with the same domain/path/name triple are replaced.

### Method
POST

### Endpoint
/api/v1/cookies/import

### Parameters
#### Request Body
- **browserProfileId** (integer) - Required - Identifier of the browser profile that will receive the cookies.
- **cookies** (array) - Required - Array of cookie objects to import.
- **browserProfilePassword** (string) - Optional - Password protecting the target profile if enabled.

### Request Example
{
  "browserProfileId": 12345,
  "cookies": [
    {
      "name": "session_id",
      "value": "abc123def456",
      "domain": ".example.com",
      "path": "/",
      "expirationDate": 1735689600000,
      "httpOnly": true,
      "secure": true,
      "sameSite": "lax"
    }
  ]
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **hash** (string) - Hash of the imported cookies.

#### Response Example
{
  "success": true,
  "hash": "a1b2c3d4e5f6g7h8i9j0"
}
```

--------------------------------

### Cookie Import Success Response

Source: https://docs.dolphin-anty-cdn.com/index.html

The JSON response returned upon a successful cookie import operation.

```json
{
  "success": true,
  "hash": "a1b2c3d4e5f6g7h8i9j0"
}
```

--------------------------------

### Import Cookies via cURL

Source: https://docs.dolphin-anty-cdn.com/index.html

Use this cURL command to remotely import cookies into a browser profile. Ensure the Authorization header is set with a valid Bearer token.

```shell
curl https://darkwing.dolphin-anty-api.com/api/v1/cookies/import \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "browserProfileId": 12345,
  "cookies": [
    {
      "name": "session_id",
      "value": "abc123def456",
      "domain": ".example.com",
      "path": "/",
      "expirationDate": 1735689600000,
      "httpOnly": true,
      "secure": true,
      "sameSite": "lax"
    }
  ]
}'
```

--------------------------------

### PATCH /proxy/{id}

Source: https://docs.dolphin-anty-cdn.com/index.html

Updates the details of an existing proxy configuration identified by its ID.

```APIDOC
## PATCH /proxy/{id}

### Description
Updates an existing proxy configuration. Most parameters are provided by the proxy provider.

### Method
PATCH

### Endpoint
/proxy/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Proxy identifier.

#### Request Body
- **host** (string) - Required - Proxy URL or IPv4/IPv6 address.
- **port** (integer) - Required - Proxy port (0-65535).
- **type** (string) - Required - Proxy protocol type (http, socks4, socks5, ssh).
- **changeIpUrl** (string) - Optional - URL that triggers IP rotation.
- **login** (string) - Optional - Username for proxy authentication.
- **name** (string) - Optional - Human-readable alias for the proxy.
- **password** (string) - Optional - Password for proxy authentication.
- **provider** (string) - Optional - Provider identifier.

### Request Example
{
  "type": "http",
  "host": "",
  "port": 0,
  "login": "",
  "password": "",
  "name": "",
  "changeIpUrl": "",
  "provider": ""
}

### Response
#### Success Response (200)
- **data** (object) - Updated proxy data object.
```

--------------------------------

### Query Parameters

Source: https://docs.dolphin-anty-cdn.com/index.html

The API supports various query parameters to filter and sort results.

```APIDOC
### Query Parameters

- **limit** (Value) - Optional - Specifies the number of items to return.
- **query** (Value) - Optional - Search query string.
- **sortBy** (Select) - Optional - Field to sort the results by.
- **order** (Select) - Optional - Sort order (e.g., ascending or descending).
- **ids** (Value) - Optional - Comma-separated list of IDs to filter by.
```

--------------------------------

### DELETE /proxy/{id}

Source: https://docs.dolphin-anty-cdn.com/index.html

Deletes a specific proxy configuration from the system.

```APIDOC
## DELETE /proxy/{id}

### Description
Removes a proxy configuration identified by its ID.

### Method
DELETE

### Endpoint
/proxy/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Proxy identifier.

### Response
#### Success Response (200)
- **success** (boolean) - Deletion result.
```

--------------------------------

### Successful cookie export response

Source: https://docs.dolphin-anty-cdn.com/index.html

JSON structure returned upon a successful cookie export operation.

```json
{
  "success": true,
  "cookies": [
    {
      "name": "session_id",
      "value": "abc123def456",
      "domain": ".example.com",
      "path": "/",
      "expirationDate": 1735689600,
      "hostOnly": false,
      "session": false,
      "httpOnly": true,
      "secure": true,
      "sameSite": "lax"
    }
  ]
}
```

--------------------------------

### Proxy List Response Schema

Source: https://docs.dolphin-anty-cdn.com/index.html

JSON structure returned by the proxy list endpoint, including pagination metadata and proxy details.

```JSON
{
  "current_page": 1,
  "first_page_url": "string",
  "from": null,
  "last_page": 1,
  "last_page_url": "string",
  "next_page_url": null,
  "path": "string",
  "per_page": 1,
  "prev_page_url": null,
  "to": null,
  "total": 1,
  "data": [
    {
      "id": 1,
      "teamId": 1,
      "userId": 1,
      "name": null,
      "type": "http",
      "host": "string",
      "port": 1,
      "login": null,
      "password": null,
      "changeIpUrl": null,
      "provider": null,
      "ip": null,
      "savedByUser": true,
      "browser_profiles_count": 1,
      "lastCheck": {
        "createdAt": "2026-08-08T20:21:12.422Z",
        "status": true,
        "ip": "string",
        "country": "string",
        "region": "string",
        "city": "string",
        "timezone": "string",
        "found": 1,
        "total": 1,
        "blacklists": [
          "string"
        ]
      },
      "createdAt": "2026-08-08T20:21:12.422Z",
      "updatedAt": "2026-08-08T20:21:12.422Z"
    }
  ]
}
```

--------------------------------

### POST /cookies/export

Source: https://docs.dolphin-anty-cdn.com/index.html

Exports cookies from a specified browser profile. This endpoint does not require the Local API.

```APIDOC
## POST /cookies/export

### Description
Allows exporting cookies remotely from a browser profile without requiring the Local API.

### Method
POST

### Endpoint
/api/v1/cookies/export

### Parameters
#### Request Body
- **browserProfileId** (integer, int64) - Required - Identifier of the browser profile to export cookies from.
- **browserProfilePassword** (string | null) - Optional - Password protecting the target profile (if requirePassword is enabled).

### Request Example
{
  "browserProfileId": 12345
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **cookies** (array) - List of exported cookies.

#### Response Example
{
  "success": true,
  "cookies": [
    {
      "name": "session_id",
      "value": "abc123def456",
      "domain": ".example.com",
      "path": "/",
      "expirationDate": 1735689600,
      "hostOnly": false,
      "session": false,
      "httpOnly": true,
      "secure": true,
      "sameSite": "lax"
    }
  ]
}
```

--------------------------------

### Update a proxy via cURL

Source: https://docs.dolphin-anty-cdn.com/index.html

Updates an existing proxy configuration using a PATCH request. Requires a valid bearer token for authorization.

```shell
curl https://dolphin-anty-api.com/proxy/1 \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "type": "http",
  "host": "",
  "port": 0,
  "login": "",
  "password": "",
  "name": "",
  "changeIpUrl": "",
  "provider": ""
}'
```

--------------------------------

### Proxy deletion response schema

Source: https://docs.dolphin-anty-cdn.com/index.html

The JSON structure returned upon a successful proxy deletion.

```json
{
  "success": true
}
```

--------------------------------

### Delete a proxy via cURL

Source: https://docs.dolphin-anty-cdn.com/index.html

Removes a proxy from the system using a DELETE request.

```shell
curl https://dolphin-anty-api.com/proxy/1 \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### PATCH /team/users/{userId}

Source: https://docs.dolphin-anty-cdn.com/index.html

Updates a specific team member by their ID (API v2).

```APIDOC
## PATCH /team/users/{userId}

### Description
Updates a team member.

### Method
PATCH

### Endpoint
/team/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier of the team member.
```

--------------------------------

### DELETE /team/users/{userId}

Source: https://docs.dolphin-anty-cdn.com/index.html

Deletes a specific team member by their ID.

```APIDOC
## DELETE /team/users/{userId}

### Description
Deletes a team member.

### Method
DELETE

### Endpoint
/team/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier of the team member.
```
Tokens:
Raw