Firsty

Search...

Search...

Getting started

Overview

What the Firsty API does and how to make a first call.

Onboard your Agent

One prompt hands your coding agent the whole local setup. It reads our setup guide, installs the Firsty CLI and claims sandbox credentials, so you can provision eSIMs without leaving your editor.

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 assumes you have API credentials. If you don't, sandbox credentials are one command away: npx firsty init claims a set and verifies them, no account needed. 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)".

firsty catalog packages --limit 2
Response · 200
{
  "data": [
    {
      "planReference": "C123456XYZDUSR",
      "name": "5GB - 30 Days - US",
      "type": "data",
      "capacityMb": 5120,
      "speedKbps": 100000,
      "throttleCapacityMb": 1024,
      "throttleSpeedKbps": 512,
      "smsCount": 100,
      "voiceSeconds": 3600,
      "validityMinutes": 43200,
      "countryCode": "US",
      "recurring": false,
      "renewalPeriodMinutes": 0
    }
  ],
  "pagination": {
    "limit": 20,
    "hasMore": true,
    "nextCursor": "MjAyNC0wMS0xNVQxMDowMDowMC4wMDBaOjQy"
  }
}

Plan references are either client-specific (C...) or shared (S...), so what a request returns depends on the account asking.

Where to go next

GuideWhat it covers
QuickstartActivate an eSIM end to end
AuthenticationCredentials, tokens and environments
eSIM lifecycleStates a profile moves through
Embedded web appEmbed Firsty instead of building against the API