IPCola

query traffic package

POST

https://api.ipcola.com/api/traffic_package/query

traffic package

Request

Header Params

Authorization

string

optional

Default:

Bearer {{AUTH_TOKEN}}

Body Params application/json

filter

object

optional

query condition

buy_end_date

string

optional

required, end date, format: 2023-02-10

buy_start_date

string

optional

required, start date, format: 2023-01-10

integer

optional

optional, specific record id

traffic_type

string

required

one of the following traffic type:"rotation_residential" or "rotation_datacenter"

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,
  "offset": 0,
  "limit": 10,
  "filter": {
    "traffic_type": "rotation_residential",
    "buy_start_date": "2023-06-01",
    "buy_end_date": "2023-06-30"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ipcola.com/api/traffic_package/query' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "from_db": true,
    "offset": 0,
    "limit": 10,
    "filter": {
        "traffic_type": "rotation_residential",
        "buy_start_date": "2023-06-01",
        "buy_end_date": "2023-06-30"
    }
}'

Responses

🟢200result

application/json

Body

current_unixtime

integer

optional

current time stamp from server

data

$ref(#/definitions/48894394)[]

optional

query result

#/definitions/48894394

optional

meta_message

string

optional

success or other error msg

meta_status

integer

optional

1 for success, negative for error

total_count

integer

optional

total record quantity

Example

buy traffic package

query rotation proxy distribution