IPCola
  1. balance
IPCola
  • User
    • user
      • send email VCode
      • get user info
      • user login
      • user register
      • get captcha
      • user reset password
    • balance
      • get user balance
        POST
    • deposit
      • deposit
      • coinbase(deprecated)
      • query deposit record
      • stripe(deprecated)
  • Rotation proxy
    • account
      • create new account
      • delete account
      • query account
      • update account
    • ip whitelist
      • add ip whitelist
      • delete ip whitelist
      • query ip whitelist
      • update ip whitelist
    • api proxy list
      • get proxy list for ip whitelist auth
    • price
      • query pay as you go price
      • query traffic package price
    • traffic package
      • buy traffic package
      • query traffic package
    • distribution
      • query rotation proxy distribution
    • proxy traffic
      • query daily traffic data
  • Static proxy
    • static direct proxy
      • buy static direct proxy
      • buy traffic
      • query static direct proxy
      • offline ip refund static direct proxy
      • online ip refund static direct proxy
      • renew
      • set ip whitelist
      • replace ip
    • static indirect proxy
      • buy static indirect proxy
      • buy traffic
      • query static transfer proxy
      • offline ip refund static transfer proxy
      • online ip refund static transfer proxy
      • renew
      • replace ip
    • distribution
      • query static indirect connect proxy distribution
      • query static direct connect proxy distribution
    • price
      • query static direct residential proxy price
      • query static direct datacenter proxy price
      • query static transfer residential proxy price
      • query static transfer datacenter proxy price
  • Common
    • public ip
      • get public ip
    • proxy address
      • query proxy address
  1. balance

get user balance

POST
/api/balance/query
balance
return result is an object {userid: balance}
balance amount / 1e12 => $, ex. 12000000000000 (12 zero) = $12.00
if meta_status==1 but the object is empty, means balance is 0

Request

Header Params
Authorization
string 
optional
Default:
Bearer {{AUTH_TOKEN}}
Body Params application/json
credit_type
string 
required
always "user_dollar"
Example
{
  "credit_type": "user_dollar"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.ipcola.com/api/balance/query' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "credit_type": "user_dollar"
}'

Responses

🟢200result
application/json
Body
meta_message
string 
required
success or other error msg
meta_status
integer 
required
1 for success, negative for error
result
object 
required
user balance object, {id:balance}
Additional properties
string 
optional
Example
{
  "meta_message": "string",
  "meta_status": 0,
  "result": {
    "property1": "string",
    "property2": "string"
  }
}
Modified at 2023-06-16 02:46:17
Previous
user reset password
Next
deposit
Built with