Getting started
Overview
What the Firsty API does and how to make a first call.
Onboard your Agent
One prompt gets your coding agent building with Firsty. It reads our guide, installs the CLI and connects your free test account, so it can order test eSIMs as it writes your integration.
The Firsty API gives you worldwide mobile data in a handful of calls. Provision an eSIM, attach a data package, and hand your user an activation code. No carrier contracts, no SIM logistics.
Everything below runs on your own test account. It's free:
create one, then npx firsty login connects the
CLI to it. See Credentials, or
talk to sales when you're ready for production access.
What you can build
- Travel apps. Sell data bundles at checkout and activate them in-app.
- Device fleets. Provision connectivity for hardware as it ships.
- Embedded connectivity. Bundle data into your own product's onboarding.
Your first call
Every API request carries a bearer token; only the token exchange itself
doesn't. See Authentication
for that exchange, or let the CLI mint one with
export FIRSTY_TOKEN="$(npx firsty auth token)".
Plan references are either client-specific (
C...) or shared (S...), so what a request returns depends on the account asking.
Where to go next
| Guide | What it covers |
|---|---|
| Quickstart | Activate an eSIM end to end |
| Authentication | Credentials, tokens and environments |
| eSIM lifecycle | States a profile moves through |
| eSIM installation | Deep links, QR codes and in-app install |
| Embedded web app | Embed Firsty instead of building against the API |