API Documentation

💰 Get Balance

Description: Retrieves the current balance of your account.

Endpoint:

GET https://api.buynumber.io/v1/account?api_key=YOUR_API_KEY&action=getBalance

📌 Parameters:

api_key (string) - Your unique API key (required)

📌 Response:

{
  "result": "success",
  "data": {
    "balance": "35.77"
  }
}

🌍 Get Countries

Description: Returns a list of available countries for activation services.

Endpoint:

GET https://api.buynumber.io/v1/activation-numbers?api_key=YOUR_API_KEY&action=getCountries

📌 Response:

{
  "result": "success",
  "data": [
    {
      "id": 0,
      "rus": "Россия",
      "eng": "Russia",
      "chn": "俄罗斯",
      "visible": 1,
      "retry": 1,
      "multiService": 1
    },
    {
      "id": 1,
      "rus": "Украина",
      "eng": "Ukraine",
      "chn": "乌克兰",
      "visible": 1,
      "retry": 1,
      "multiService": 1
    },
    ..
    ..
}

🌍 Get Services

Description: Returns a list of available services.

Endpoint:

GET https://api.buynumber.io/v1/activation-numbers?api_key=YOUR_API_KEY&action=getServices

📌 Response:

{
  "result": "success",
  "data": [
    {
      "code": "full",
      "name": "Full rent"
    },
    {
      "code": "ig",
      "name": "Instagram+Threads"
    },
    ..
    ..
}

🌍 Get Top Countries by Service

Description: Returns a list of the most popular countries for a specific service.

Endpoint:

GET https://api.buynumber.io/v1/activation-numbers?api_key=YOUR_API_KEY&action=getTopCountriesByService&service=SERVICE_CODE

📌 Parameters:

api_key (string) - Your unique API key (required)
service (string) - The service code for which top countries are needed (required)
all_prices (BOOLEAN: true/false) - Show prices for all servers

📌 Response (all_prices=false):

{
  "result": "success",
  "data": [
    {
      "country": 33,
      "price": 0.72,
      "count": 100
    },
    {
      "country": 62,
      "price": 2.4,
      "count": 9179
    }
    ..
    ..
    ]
}

📌 Response (all_prices=true):

{
  "result": "success",
  "data": [
    {
      "country": 62,
      "count": 32179,
      "prices": [
        "1.71",
        "3.20"
      ]
    },
    {
      "country": 33,
      "count": 14305,
      "prices": [
        "0.66",
        "0.68",
        "0.78",
        "0.82",
        "0.99",
        "1.00",
        "1.02",
        "1.04",
        "1.21"
      ]
    },
    ..
    ..
    ]
}

Note: If "all_price" is set to FALASE, the displayed price will be the maximum "price" for the selected service and country [number].

📞 Purchase a New Number

Description: Buys a temporary number for verification.

Endpoint:

GET https://api.buynumber.io/v1/activation-numbers?api_key=YOUR_API_KEY&action=newNumber&service=SERVICE_CODE&country=COUNTRY_ID&max_price=MAX_PRICE

📌 Parameters:

api_key (string) - Your unique API key (required)
country (integer) - Country ID (required)
service (string) - Service Code (required)
max_price (float) - The maximum price you are willing to pay for this number (will be searched across all servers)

📌 Response:

{
  "result": "success",
  "data": {
    "id": "112142",
    "phoneNumber": "79291640427",
    "price": "6.72",
    "countryId": "0",
    "canGetAnotherSms": false,
    "startTime": "2025-02-10 15:55:13",
    "endTime": "2025-02-10 16:15:13"
  }
}

Note: Note: If the "max_price" parameter is not provided, the server with the lowest available price will be selected by default.

📩 Get SMS

Description: Retrieves SMS messages received by a purchased number.

Endpoint:

GET https://api.buynumber.io/v1/activation-numbers?api_key=YOUR_API_KEY&action=getSms&id=NUMBER_ID

📌 Parameters:

id (integer) - Purchased number ID (required)

📌 Response:

{
  "result": "success",
  "data": {
    "code": ["123456"],
    "sms": ["Your verification code is 123456"],
  }
}

🔄 Set Status

Description: Updates the status of a purchased number.

Endpoint:

GET https://api.buynumber.io/v1/activation-numbers?api_key=YOUR_API_KEY&action=setStatus&id=NUMBER_ID&status=NEW_STATUS

📌 Parameters:

id (integer) - Purchased number ID (required)
status (string) - New status ["cancel" or "complete"] (required)

📌 Response:

{
    "result": "success"
}