Get started with the API

This quickstart takes you from no key to reading your earnings and managing the numbers you sell. Every request and response below is real in shape; your figures will differ. For every endpoint and parameter, see the API reference.

Turn on API access#

1. Go to Settings → Profile & Preferences.
2. Tick Allow API Access.
3. Copy the API Key and click Save. Regenerate replaces the key at once; the old one stops working.

The examples read your credentials from the environment:

export TCXC_USERNAME="your-portal-username"
export TCXC_API_KEY="the-key-from-preferences"

Read your balance#

Your seller balance is what buyers' traffic has earned you, less payouts and fees.

curl --digest -u "$TCXC_USERNAME:$TCXC_API_KEY" -X POST \
  https://apiv2.telecomsxchange.com/sellers/balance

{"status": "success", "balance": "22631.26"}

Check your payouts#

Payout History, as in the portal: payouts, their fees, HLR lookups and anonymous-listing fees.

curl --digest -u "$TCXC_USERNAME:$TCXC_API_KEY" -X POST \
  https://apiv2.telecomsxchange.com/sellers/payhistory \
  -d "date_from=2026-10-01 00:00:00" -d "date_to=2026-10-31 23:59:59"

{
  "status": "success",
  "transactions": [
    {"i_payout": "2873", "amount": "500", "ts": "2026-10-14 22:14:41", "notepad": "Bank Wire"}
  ]
}

Manage the numbers you sell#

List your numbers, optionally from a prefix:

curl --digest -u "$TCXC_USERNAME:$TCXC_API_KEY" -X POST \
  https://apiv2.telecomsxchange.com/sellers/did/list -d prefix=380

Each number shows its rates (price_1, smpp_price), setup_fee and monthly_fee, its status (idle until a buyer purchases it), capabilities (voice, sms, fax, video) and whether it needs KYC (verification_required). Add a number with /sellers/did/add and change one with /sellers/did/edit/{i_did}; see Phone numbers for every field.

Message your buyers#

List the buyers who use your routes, then write to one or all of them. Messages land in their portal inbox and by email.

curl --digest -u "$TCXC_USERNAME:$TCXC_API_KEY" -X POST \
  https://apiv2.telecomsxchange.com/sellers/buyers/list

See Messages for sending, replying and reading your inbox.

Where next#

What if something goes wrong?#