query static transfer proxy

Request

Header Params

Authorization

string

optional

Default:

Bearer {{AUTH_TOKEN}}

Body Params application/json

filter

object

required

query condition

country_code

string

optional

is_datacenter

boolean

required

true for datacenter, false for residential

node_ipv4_array

array[string]

optional

optional, proxy ip array

from_db

boolean

required

from db or cache

limit

integer

optional

query quantity for pagination

offset

integer

optional

query offset for pagination

Example

{
    "from_db": true,
    "filter": {
        "is_datacenter": true
    },
    "limit": 10,
    "offset": 0
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.ipcola.com/api/static_transfer_proxy/query' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "from_db": true,
    "filter": {
        "is_datacenter": true
    },
    "limit": 10,
    "offset": 0
}'

Responses

🟢200result

application/json

Body

current_unixtime

integer

required

current time stamp from server

data

array [object {25}]

required

query result

account_name

string

optional

auth

account_password

string

optional

auth password

city

string

optional

continent_code

string

optional

country_code

string

optional

created_unixtime

integer

optional

expire_unixtime

integer

optional

a unix timestamp

forbidden

boolean

optional

id

integer

optional

ip_whitelist

array[string]

optional

ip array

ip_whitelist_count_limit

integer

optional

is_datacenter

boolean

optional

is_online

boolean

optional

is_satellite

boolean

optional

is_stable

boolean

optional

status, not in db, get value when query

isp

string

optional

node_ipv4

string

optional

ip info

port

integer

optional

refund_unixtime

integer

optional

if >0 means refunded

region

string

optional

to_update

boolean

optional

update flag. set to true if any update happened, set to false when update send to node

traffic_cap

integer

optional

total capacity == old capacity + new bought

traffic_used

integer

optional

traffic

user_id

integer

optional

user_tag

string

optional

meta_message

string

required

success or other error msg

meta_status

integer

required

1 for success, negative for error

total_count

integer

required

total record quantity

Example

{
    "current_unixtime": 0,
    "data": [
        {
            "account_name": "string",
            "account_password": "string",
            "city": "string",
            "continent_code": "string",
            "country_code": "string",
            "created_unixtime": 0,
            "expire_unixtime": 0,
            "forbidden": true,
            "id": 0,
            "ip_whitelist": [
                "string"
            ],
            "ip_whitelist_count_limit": 0,
            "is_datacenter": true,
            "is_online": true,
            "is_satellite": true,
            "is_stable": true,
            "isp": "string",
            "node_ipv4": "string",
            "port": 0,
            "refund_unixtime": 0,
            "region": "string",
            "to_update": true,
            "traffic_cap": 0,
            "traffic_used": 0,
            "user_id": 0,
            "user_tag": "string"
        }
    ],
    "meta_message": "string",
    "meta_status": 0,
    "total_count": 0
}