Skip to content
API Reference

Search is only available in production builds. Try building and previewing the site to test it out locally.

External integrations

Raw calls outside the REST client: the DexScreener profile order and the pump.fun charity directory.

These calls do not go through the Proxima REST client and therefore skip its 2FA and session handling.

  • The DexScreener order is a raw fetch to the main API host.
  • The charity directory is a Proxima-hosted lookup at https://charities.proxima.tools, used when a creator routes fee shares to a pump.fun charity.

The X tracker also loads third-party images through https://wsrv.nl/?url=...&w=1024&we (a public CORS image proxy) and avatars from https://unavatar.io/x/{handle}. Those are public services, not Proxima APIs, and are not documented here.

POST https://api-mig.proxima.tools/evm/dexscreener/create-order

Served outside the main API host.

Submits a token profile update to DexScreener and returns a payment link.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Do not retry blindly Each call creates a new order with its own payment link, and no endpoint lists existing orders. Retry only when the first call surely did not reach the server.

Sent from the "Update DexScreener" modal of a live launch. The web client opens the returned paymentLink in a new tab.

Unlike the REST client, this call sends the session JWT without the Bearer prefix (Authorization: <JWT>); the API's auth middleware accepts both forms. Any non-2xx is shown as "Failed to update token on Dex Screener". The host is the main API.

Headers

  • Authorization string Required
    The bare Proxima session JWT.
  • X-Sent-At string Optional
    Client send time in epoch milliseconds.

Form fields multipart/form-data

  • tokenImage file Required
    Square token image (the modal crops to 1:1).
  • tokenHeader file Optional
    Header banner image.
  • data string Required
    JSON-encoded profile.
    Child attributes 5
    • chainId string Required
      DexScreener chain id. The web client always sends solana.
    • tokenAddress string Required
      Token mint.
    • description string Optional
      Token description.
    • socials array<object> Optional
      { type: "telegram" | "x" | "discord", url } entries.
    • websites array<object> Optional
      { label, url } entries (Website, Docs, then any extra links).

Returns 200 OK · application/json

  • paymentLink string
    URL where the user pays for the DexScreener order.

Errors

Only the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.

Web client useCreateDexScreenerOrder(apiKey).mutate(formData) src/lib/queries/useLaunchMutations.ts

GET https://charities.proxima.tools/

Served outside the main API host.

Searches the pump.fun charity directory by name.

Token
None. This endpoint is public.
Retry
Safe to retry

Called from the charity picker when a creator assigns a fee share to a charity. Any non-2xx is thrown as "pump.fun charity search failed".

Query parameters

  • term string Required
    Search text.
    Examplewater
  • limit integer Optional Default 50
    Maximum results.

Headers

  • Accept string Optional
    application/json.
  • X-Sent-At string Optional
    Client send time in epoch milliseconds.

Returns 200 OK · application/json

  • pageKey string | null
    Pagination key. The web client does not page.
  • response array<object>
    Matching charities (see Retrieve a charity).

Errors

Only the common errors: 429 when rate limited.

Web client searchCharities({ term, limit }) src/lib/pumpfunCharity/client.ts

GET https://charities.proxima.tools/charities/{charity_id}

Served outside the main API host.

Returns one charity from the pump.fun directory.

Token
None. This endpoint is public.
Retry
Safe to retry

Used to resolve charity names on creator fee shares that only carry a charity_id. Names are cached in memory for the session.

Path parameters

  • charity_id string Required
    Charity ID.
    Exampleb2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e

Headers

  • Accept string Optional
    application/json.
  • X-Sent-At string Optional
    Client send time in epoch milliseconds.

Returns 200 OK · application/json

  • id string
    Charity ID.
  • name string
    Display name.
  • slug string
    URL slug.
  • logo string
    Logo URL.
  • website string
    Website URL.
  • address string
    Street address.
  • city string
    City.
  • state string
    State or region.
  • country string
    Country.
  • zipCode string
    Postal code.
  • taxId string
    Tax identifier.
  • isVerified boolean
    Verified by the directory.
  • isEnabled boolean
    Accepting donations.
  • socials object
    Optional twitter, facebook, instagram, linkedin, youtube, blog URLs.

Errors

Only the common errors: 429 when rate limited.

Web client getCharity({ id }) src/lib/pumpfunCharity/client.ts