How to use the SMSPool API

• By SMSPool Admin
• December 20, 2021
• SMSPool

What is the SMSPool API?

The SMSPool API lets your own software do everything you can do on our website: order SMS verifications, manage rentals and eSIMs, check your balance and more. Connect it to your scripts, bots or applications to automate your workflow.

How do I use the SMSPool API?

All endpoints live under https://api.smspool.net/, and using the API is free; you only pay for what you order. Every request returns JSON, and parameters can be sent as a GET query or as POST form fields unless an endpoint says otherwise.

Authenticate with your API key, which you can find on your settings page. Send it as a bearer token (Authorization: Bearer YOUR_API_KEY) or as a key parameter. Your API key gives full access to your orders and balance, so never share it.

Where can I find the documentation?

The full API reference is at https://api.smspool.net/docs. It lists every endpoint with its parameters and example responses, and lets you send test requests from your browser.

Prefer a ready-made client? We have official SDKs for Python, JavaScript, PHP, Go, .NET, Java and Ruby.

What can I do with the API?

• Order SMS verifications for hundreds of services and countries
• Rent numbers for longer periods and read their messages
• Buy and manage data-only eSIMs
• Run carrier lookups on phone numbers
• Check your balance, active orders and order history

Are there rate limits?

For standard accounts, each endpoint allows up to 600 requests per minute. A few have lower limits: /sms/check and /sms/stock allow 200 per minute, and /sms/cancel allows 150. Requests made without an API key are limited by IP address, to 20 per minute on /sms/check, /sms/stock, /request/pricing and /service/retrieve_all.

These endpoints have no rate limit: /request/active, /request/balance, /request/orders, /preorder/all, /rental/retrieve_messages and /rental/retrieve_status. To follow your orders, poll /request/active, which returns all of them at once, instead of calling /sms/check for each one.

If you go over a limit, the API answers with HTTP status 429; wait a moment and try again.

Failed orders, such as ordering a service that is out of stock, have their own limit. After 150 failed orders within 5 minutes, ordering is paused for 5 minutes. If your overall success rate drops below 10%, ordering is paused for up to 6 hours.

Business accounts have no API rate limits and no failed-order pauses. Read more about business accounts.

Do you support the SMS-Activate / Hero-SMS API?

Yes. Point your existing SMS-Activate or Hero-SMS client at https://api.smspool.net/stubs/handler_api and use your SMSPool API key as api_key.

Supported actions: getPrices, getBalance, getNumber, getStatus and setStatus. Supported parameters: action, service, country, maxPrice, pool (or operator) and id.

By default, services and countries use SMS-Activate / Hero-SMS IDs. To use SMSPool's IDs instead, add setting=smspool to the URL's query string.

Return to knowledgebase