Sign In Sign Up
Sign In Sign Up
Developers

API Documentation

Integrate getBoost Vnumber into your own apps. Resell virtual numbers and social boosting using your wallet balance.

Log in for your API key

Authentication

Pass your personal API key on every request. Find or regenerate it in the developer API area after logging in.

api_key=YOUR_API_KEY

Number API

Virtual numbers and OTP — base path https://number.getboost.ng/api/v1. Responses are plain text unless noted.

Flow: servers → countries → services (with prices) → get-number

GET /api/v1/balance

Returns wallet balance as plain text.

https://number.getboost.ng/api/v1/balance?api_key=YOUR_API_KEY Response: ACCESS_BALANCE:25.40
GET /api/v1/servers

List active number servers (JSON).

https://number.getboost.ng/api/v1/servers?api_key=YOUR_API_KEY { "status": "success", "servers": [{ "id": 1, "name": "Server A" }] }
GET /api/v1/countries

Countries for a server (JSON). Requires server_id from servers list.

https://number.getboost.ng/api/v1/countries?api_key=YOUR_API_KEY&server_id=1 { "status": "success", "countries": [{ "id": 5, "name": "United States", "code": "US", "country_id": "12" }] }
GET /api/v1/services

Services with prices for a server + country (JSON). Use code when ordering.

https://number.getboost.ng/api/v1/services?api_key=YOUR_API_KEY&server_id=1&country=5 { "status": "success", "services": [ { "id": 10, "code": "wa", "name": "WhatsApp", "price": "1.50" } ] }
GET /api/v1/get-number

Buy a virtual number. Deducts wallet balance at the listed price.

https://number.getboost.ng/api/v1/get-number?api_key=YOUR_API_KEY&country=COUNTRY_ID&service=SERVICE_CODE Response: ACCESS_NUMBER:ORDER_ID:+1234567890
GET /api/v1/status

Poll SMS/OTP for an order.

https://number.getboost.ng/api/v1/status?api_key=YOUR_API_KEY&id=ORDER_ID Responses: STATUS_WAIT_CODE | STATUS_OK:123456 | STATUS_CANCEL
GET /api/v1/set-status

Cancel (8) or request retry (3) while waiting for SMS.

https://number.getboost.ng/api/v1/set-status?api_key=YOUR_API_KEY&id=ORDER_ID&status=8

Plain-text errors: BAD_KEY, BAD_API, BAD_COUNTRY, BAD_SERVICE, NO_BALANCE.

Need Help?

Having trouble integrating? Reach out via our contact page and our team will assist you.