Check

πŸ“˜ API Documentation

A guide to easy connection to our API for developers

πŸ’° 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)

πŸ“Œ Response:

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

πŸ“ž 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

πŸ“Œ Parameters:

  • api_key (string) - Your unique API key (required)
  • country (integer) - Country ID (required)
  • service (string) - Service Code (required)

πŸ“Œ 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"
  }
}

πŸ“© 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

πŸ“Œ 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&status=NEW_STATUS

πŸ“Œ Parameters:

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

πŸ“Œ Response:

{
    "result": "success"
}