SMSPool Python SDK

Official Python client for the SMSPool API: one-time SMS verification numbers, rentals, pre-orders, eSIMs and more.

Package: smspool-sdk on PyPI.

Install

pip install smspool-sdk

Quick start

Get your API key from your settings page.

import smspool_sdk

config = smspool_sdk.Configuration(access_token="YOUR_API_KEY")
with smspool_sdk.ApiClient(config) as client:
    print(smspool_sdk.InformationApi(client).request_balance())
    countries = smspool_sdk.InformationApi(client).country_retrieve_all()
    order = smspool_sdk.SMSApi(client).purchase_sms(country="US", service="1")

Errors (HTTP 4xx/5xx) raise smspool_sdk.rest.ApiException, with .status and .body.

Calling endpoints

Every endpoint in the API reference is a method named after its path, on the class for its section: /sms/check is sms_check() on SMSApi. Endpoints that need your API key send it as a bearer token.

Responses are returned as decoded JSON exactly as the API sends them: many endpoints answer 200 with "success": 0 and a message when a request is refused, so check success.

• Generated reference for every method and parameter: docs/
• API reference with examples: https://api.smspool.net/docs

How this SDK is made

The code is generated from the API's OpenAPI spec (openapi.json) with OpenAPI Generator. Do not edit generated files by hand: a workflow regenerates them every week and opens a pull request when the API changed. Hand-written files are listed in .openapi-generator-ignore.

Releasing (maintainers)

1. Set the new version in openapi-generator.yaml (packageVersion).
2. Run scripts/generate.sh (needs Docker) and scripts/smoke.sh, then commit.
3. Tag and push: git tag vX.Y.Z && git push origin vX.Y.Z.

The Release workflow checks the tag against the version, runs the smoke test and publishes. PyPI uses trusted publishing (no token): the project's publisher is this repo's release.yml workflow in the release environment.

License

MIT