Partner API documentation

Overview

The Partner API lets you show your own users how much SOL they can reclaim from dormant Solana token accounts, directly in your UI. It answers one question — "what's in this wallet?" — and nothing else. Building or submitting a transaction, and holding a private key, are never part of what an API key can do; that always happens on getbacksol.com, signed by the user's own wallet.

Getting an API key

Self-service, free, instant — no manual approval. Sign up at getbacksol.com/partners and you'll get a key immediately. We only store its SHA-256 hash, so save it somewhere safe the moment you see it — it can't be recovered afterward, only reissued.

Authentication

Send your key in the X-API-Key header on every request.

X-API-Key: gbs_live_yourkeyhere

Rate limits

30 requests per minute per key, tracked in a fixed one-minute window. Generous for a real product UI; a 429 response means you've hit it — back off and retry after the current minute rolls over.

Endpoint: scan a wallet

GET https://getbacksol.com/api/v1/scan?wallet=<address>

walletis any Solana wallet address, as a query parameter. Read-only: this endpoint never touches a private key and can't build or submit anything.

Example request

curl "https://getbacksol.com/api/v1/scan?wallet=6mBmVBchk7UnW1FdfN3bm6KKTV376UxuZ3je7sEzjpd1" \
  -H "X-API-Key: gbs_live_yourkeyhere"

// JavaScript
const res = await fetch(
  "https://getbacksol.com/api/v1/scan?wallet=" + wallet,
  { headers: { "X-API-Key": apiKey } }
);
const data = await res.json();

# Python
import requests

res = requests.get(
    "https://getbacksol.com/api/v1/scan",
    params={"wallet": wallet},
    headers={"X-API-Key": api_key},
)
data = res.json()

Example response

{
  "wallet": "6mBmVBchk7UnW1FdfN3bm6KKTV376UxuZ3je7sEzjpd1",
  "network": "mainnet-beta",
  "feeRate": 0.3,
  "closable": {
    "count": 2,
    "grossReclaimable": 0.004079,
    "netReclaimable": 0.002855,
    "accounts": [
      { "pubkey": "...", "mint": "...", "programId": "...", "reclaimable": 0.00204 }
    ]
  },
  "dust": {
    "count": 1,
    "accounts": [
      { "pubkey": "...", "mint": "...", "programId": "...", "reclaimable": 0.00204, "needsBurn": true, "rawAmount": "1250" }
    ]
  }
}

closable accounts have a zero token balance and can be closed right away. dust accounts still hold a small residual balance and need Safe-Burn (or a sell route) before they can close — grossReclaimable/netReclaimable only cover the closableset, since dust can't be reclaimed until it's dealt with first.

Error responses

401  Invalid or missing X-API-Key.
429  Rate limit exceeded. Try again in a minute.
400  Missing or invalid 'wallet' query parameter.
503  Scan is temporarily unavailable.

Sending users to actually reclaim

The scan is informational only. When a user wants to act on it, link them to getbacksol.com/?ref=<your-partner-id>. They connect their own wallet there and sign the close/burn transaction directly with us — your integration is never in that path.

Revenue share: 60%

Every reclaim referred through your ?ref= link credits your account with 60% of our 30% service fee — calculated from the real, confirmed on-chain transfer amount at the moment the transaction lands, never from a number your integration reports. Check your running total at any time:

GET https://getbacksol.com/api/affiliate/stats?wallet=<your-partner-id>