Youproxy
  • Welcome
  • How to start
    • Authorization
    • Custom settings
    • Preparations to create an order
    • Extend
    • Possible mistakes
  • API reference
    • Proxy type
    • Balance
    • Country
    • Rent period
    • Mobile operator
    • Promo codes
    • Price calculation
      • Calculate an order
      • Extend by IPs
      • Extend by orders ID
    • Create an order
    • Extend
      • Extend by IP addresses
      • Extend by order IDs
    • Auto-extend
      • Auto-extend by IP addresses
      • Auto-extend by order IDs
    • Get IP addresses
      • Get all
      • Get all by proxy type
      • Get page of all by proxy type
    • Possible errors
Powered by GitBook
On this page
  • View account balance
  • Path parameters
  • Response
  1. API reference

Balance

View account balance

The request allows to view current balance of the account.

GET /client/api/v1/{apiKey}/balance

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Response

200: OK Success response
{
    "success": true,
    "balance": 25.03,
    "currencyCode": "USD",
    "error": null
}
200: OK Error response
{
    "success": false,
    "balance": null,
    "currencyCode": null,
    "error":
    {
        "code": 2,
        "message": "Error api key"
    }
}
PreviousProxy typeNextCountry

Last updated 1 month ago