Skip to content
API Reference

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

Allowlist

Control and inspect the run of an allowlist launch.

An allowlist launch is a Meteora DBC launch on Solana whose curve only a sealed group of the launch's own holders may buy. Once the launch starts, the backend drives the run step by step (hook, allowlist, seal, pool, trades, migration, verification); these endpoints pause, resume and inspect it, and lock the migrated liquidity.

Allowlist launches are in beta: every endpoint answers 403 unless the account has beta access. Raw amounts are decimal strings (6 decimals for both the base token and USDC).

Progress of an allowlist run: its state, the step in flight and the curve it trades.

Attributes

  • ok boolean
    Always true on success.
  • state enum
    Run state.
    Possible values draftplannedrunningpausedfinishedfailed
  • driving boolean
    true while the backend is settling a step it has in flight.
  • last_error string | null
    Last error the run hit.
  • progress object
    Counters.
    Child attributes 5
    • steps_done integer
      Steps completed.
    • steps_total integer
      Steps in the run.
    • trades_done integer
      Trades completed.
    • trades_total integer
      Trades in the run.
    • migrated boolean
      Whether the pool has migrated.
  • current_step object | null
    The step in flight.
    Child attributes 13
    • ordinal integer
      Position of the step in the run.
    • action_id string
      Step identifier.
    • attempt integer
      Retry count.
    • kind enum
      Step kind.
      Possible values hook_initadd_walletssealconfigpooltrademigrateverifylock_lp
    • status enum
      Step status.
      Possible values plannedsignedsubmittedunknownconfirmedfailed
    • wallet_index integer | null
      Holder index for a trade step.
    • side enum | null
      Trade side.
      Possible values buysell
    • tokens string | null
      Token amount, raw units.
    • quote string | null
      Quote amount, raw units.
    • quote_limit string | null
      Quote limit of the trade, raw units.
    • final_fill boolean
      Whether this trade is the final fill.
    • signature string | null
      Transaction signature.
    • error string | null
      Error of the step.
  • eta_ms integer | null
    Estimated time left, in milliseconds. null unless running or planned.
  • eta_at_ms integer | null
    Estimated finish time, epoch milliseconds.
  • verification object | null
  • curve object
    The curve the run trades.
    Child attributes 4
    • inputs object
      The curve inputs the launch was created with (budget, migration_fdv, opening_fdv, supply, fee and interval settings). Numbers may come as strings.
    • config object
      The curve config, values as decimal strings.
    • group array<string>
      Holder wallets in the allowlist.
    • plan object | null

The planned run of an allowlist launch, as the expected funding and the run status both report it. Raw amounts are decimal strings; lamport amounts are numbers.

Attributes

  • quote_mint string
    Quote mint of the curve.
  • quote_decimals integer
    Decimals of the quote token.
  • wallets integer
    Number of holder wallets in the group.
  • trades integer
    Number of trades the run makes.
  • gross_buys string
    Quote spent on buys, raw units.
  • sales string
    Quote received from sells, raw units.
  • net_spend string
    Net quote spent, raw units.
  • quote_needed string
    Quote the group must hold, raw units.
  • sol_per_wallet integer
    SOL each wallet needs, lamports.
  • dev_sol integer
    SOL the dev wallet needs, lamports.
  • top_ten_bps integer
    Share of supply the top ten holders end with, in basis points.
  • top_ten_limit_bps integer
    Ceiling on that share, in basis points.
  • duration_ms integer
    Planned duration of the run, in milliseconds.
  • exit_estimate object | null
    Theoretical quote one sale of the group's tokens would bring.
    Child attributes 6
    • estimate boolean
      Always true: a theoretical figure, never a promise.
    • basis enum
      migration: the pool the curve opens at its threshold; pool: the migrated pool now.
      Possible values migrationpool
    • fee_bps integer
      Pool fee used, in basis points.
    • tokens string
      Tokens sold in the estimate, raw units.
    • quote_out string
      Quote the sale would bring, raw units.
    • fee string
      Fee paid on the sale, raw units.

The acceptance checks of an allowlist run, read from the chain at request time.

Attributes

  • ok boolean
    true when every check passes.
  • checks array<object>
    Acceptance checks read from the chain: distinct_balances, group_sum, top_ten, sol_floor, allowlist_sealed, hook_removed, authorities, migrated, liquidity_locked and creator_position_held.
    Child attributes 3
    • name string
      Check name.
    • ok boolean
      Whether the check passes.
    • detail string
      What was measured.
  • exit_estimate object | null
    Informative exit estimate; never a check.
    Child attributes 6
    • estimate boolean
      Always true: a theoretical figure, never a promise.
    • basis enum
      migration: the pool the curve opens at its threshold; pool: the migrated pool now.
      Possible values migrationpool
    • fee_bps integer
      Pool fee used, in basis points.
    • tokens string
      Tokens sold in the estimate, raw units.
    • quote_out string
      Quote the sale would bring, raw units.
    • fee string
      Fee paid on the sale, raw units.

Pause an allowlist run

Bearer JWT beta
POST /launch/allowlist/pause/{launch_id}

Stops the run before its next broadcast.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Pausing a paused run changes nothing: the repeat answers 409 the run is not in a state that allows this.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

  • ok boolean
    Always true on success.
  • state enum
    Run state after the transition.
    Possible values draftplannedrunningpausedfinishedfailed

Errors

StatusCodeWhen and what to do
400 bad_request launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it.
404 not_found No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch.
403 forbidden The license in your token has no beta access. Checked before the launch ID. Use a token upgraded onto a license with beta access.
409 conflict The run is not running (it is draft, planned, paused or failed). Read Retrieve allowlist run status and pause only a running run.
400 unsupported_chain The launch is not on Solana. The body adds chain. Call it only for Solana launches (IDs starting with 101).
404 not_found The launch exists but is not an allowlist curve launch. Call it only for a Meteora DBC launch created with create_params.allowlist.
409 conflict The run has already finished. Nothing is left to drive; read the outcome with Retrieve allowlist verification.
409 conflict The run changed state between the check and the update, for example because it finished or failed meanwhile. Read Retrieve allowlist run status and act on the state it reports.

Also 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 proxima.launch.allowlist.pause(launchId) src/lib/proxima/endpoints/launch/allowlist.ts

Resume an allowlist run

Bearer JWT beta
POST /launch/allowlist/resume/{launch_id}

Drives a paused or failed run from its first unfinished step.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry The run journals every step and only one worker drives it, so a repeat never sends a step twice; on a run already running it answers 409.

A backend restart always leaves a run paused.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

  • ok boolean
    Always true on success.
  • state enum
    Run state after the transition.
    Possible values draftplannedrunningpausedfinishedfailed

Errors

StatusCodeWhen and what to do
400 bad_request launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it.
404 not_found No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch.
403 forbidden The license in your token has no beta access. Checked before the launch ID. Use a token upgraded onto a license with beta access.
409 conflict The run is draft, planned or already running; only a paused or failed run resumes. Resume only a paused or failed run; a planned run starts with Launch a token.
400 unsupported_chain The launch is not on Solana. The body adds chain. Call it only for Solana launches (IDs starting with 101).
404 not_found The launch exists but is not an allowlist curve launch. Call it only for a Meteora DBC launch created with create_params.allowlist.
409 conflict The backend is still settling the step that was in flight (driving is true in the status). Wait until Retrieve allowlist run status reports driving: false, then resume.
409 conflict The run has already finished. Nothing is left to drive; read the outcome with Retrieve allowlist verification.
409 conflict The run changed state between the check and the update, for example because it finished or failed meanwhile. Read Retrieve allowlist run status and act on the state it reports.

Also 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 proxima.launch.allowlist.resume(launchId) src/lib/proxima/endpoints/launch/allowlist.ts

Migrate an allowlist run

Bearer JWT beta
POST /launch/allowlist/migrate/{launch_id}

Drives a run whose trades have all settled through migration and verification.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry The run journals every step and only one worker drives it, so a repeat never sends the migration twice; once the run has finished it answers 409 the run is finished.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

  • ok boolean
    Always true on success.
  • state enum
    Run state after the transition.
    Possible values draftplannedrunningpausedfinishedfailed

Errors

StatusCodeWhen and what to do
400 bad_request launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it.
404 not_found No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch.
403 forbidden The license in your token has no beta access. Checked before the launch ID. Use a token upgraded onto a license with beta access.
409 conflict The run is draft or planned: the launch has not started. Start the launch first with Launch a token.
400 unsupported_chain The launch is not on Solana. The body adds chain. Call it only for Solana launches (IDs starting with 101).
404 not_found The launch exists but is not an allowlist curve launch. Call it only for a Meteora DBC launch created with create_params.allowlist.
409 conflict A step before the migration (setup or trade) is not confirmed yet. Wait until every trade is confirmed in Retrieve allowlist run status, then migrate.
409 conflict The run is paused or failed and the backend is still settling its last step. Wait until Retrieve allowlist run status reports driving: false, then migrate.
409 conflict The run has already finished. Nothing is left to drive; read the outcome with Retrieve allowlist verification.

Also 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 proxima.launch.allowlist.migrate(launchId) src/lib/proxima/endpoints/launch/allowlist.ts

Lock allowlist liquidity

Bearer JWT beta
POST /launch/allowlist/lock-lp/{launch_id}

Locks the unlocked liquidity of the creator position on the migrated pool.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A repeat settles a lock still in flight (settled: true) or answers locked: "nothing left unlocked"; it never locks twice. While the first call is still running, the repeat answers 422 the run is busy; try again once it settles.

Never automatic. Refused before the migration has settled, when a keeper migrated the pool first (the positions it opened are then unknown), and when a position is held by a wallet other than the run's dev wallet.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

  • ok boolean
    Always true on success.
  • lock object
    The lock action.
    Child attributes 7
    • action_id string
      Step identifier.
    • signature string
      Transaction signature.
    • settled boolean
      true when the call only settled a lock already in flight; no new transaction was sent.
    • locked string
      "nothing left unlocked" when every position is already locked; nothing is sent and no other field is set.
    • positions array<object>
      Positions locked.
      Child attributes 2
      • position string
        Position account.
      • liquidity string
        Liquidity locked in it.

Errors

StatusCodeWhen and what to do
400 bad_request launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it.
404 not_found No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch.
403 forbidden The license in your token has no beta access. Checked before the launch ID. Use a token upgraded onto a license with beta access.
422 unprocessable The migration step is not confirmed yet. Run Migrate an allowlist run and lock once Retrieve allowlist run status reports progress.migrated: true.
400 unsupported_chain The launch is not on Solana. The body adds chain. Call it only for Solana launches (IDs starting with 101).
404 not_found The launch exists but is not an allowlist curve launch. Call it only for a Meteora DBC launch created with create_params.allowlist.
422 unprocessable A position with unlocked liquidity is held by a wallet other than the run's dev wallet. Lock that position yourself from the wallet that holds its NFT.
422 unprocessable A keeper migrated the pool before the run did, so the positions the migration opened are unknown. Lock the creator position outside Proxima, from the wallet that holds its NFT.
422 unprocessable The backend is driving the run or settling another lock for this launch. Wait until Retrieve allowlist run status reports driving: false, then try again.
422 unprocessable The lock transaction failed simulation; nothing was sent. Fix the cause given in message, for example the dev wallet's SOL for fees, then try again.

Also 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 proxima.launch.allowlist.lockLp(launchId) src/lib/proxima/endpoints/launch/allowlist.ts

GET /launch/allowlist/status/{launch_id}

Returns the run's state, progress, step in flight and curve.

Token
Upgraded session token, bound to a license.
Read-only tokens
Allowed.
Retry
Safe to retry

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

Returns an Allowlist status object.

  • ok boolean
    Always true on success.
  • state enum
    Run state.
    Possible values draftplannedrunningpausedfinishedfailed
  • driving boolean
    true while the backend is settling a step it has in flight.
  • last_error string | null
    Last error the run hit.
  • progress object
    Counters.
    Child attributes 5
    • steps_done integer
      Steps completed.
    • steps_total integer
      Steps in the run.
    • trades_done integer
      Trades completed.
    • trades_total integer
      Trades in the run.
    • migrated boolean
      Whether the pool has migrated.
  • current_step object | null
    The step in flight.
    Child attributes 13
    • ordinal integer
      Position of the step in the run.
    • action_id string
      Step identifier.
    • attempt integer
      Retry count.
    • kind enum
      Step kind.
      Possible values hook_initadd_walletssealconfigpooltrademigrateverifylock_lp
    • status enum
      Step status.
      Possible values plannedsignedsubmittedunknownconfirmedfailed
    • wallet_index integer | null
      Holder index for a trade step.
    • side enum | null
      Trade side.
      Possible values buysell
    • tokens string | null
      Token amount, raw units.
    • quote string | null
      Quote amount, raw units.
    • quote_limit string | null
      Quote limit of the trade, raw units.
    • final_fill boolean
      Whether this trade is the final fill.
    • signature string | null
      Transaction signature.
    • error string | null
      Error of the step.
  • eta_ms integer | null
    Estimated time left, in milliseconds. null unless running or planned.
  • eta_at_ms integer | null
    Estimated finish time, epoch milliseconds.
  • verification object | null
  • curve object
    The curve the run trades.
    Child attributes 4
    • inputs object
      The curve inputs the launch was created with (budget, migration_fdv, opening_fdv, supply, fee and interval settings). Numbers may come as strings.
    • config object
      The curve config, values as decimal strings.
    • group array<string>
      Holder wallets in the allowlist.
    • plan object | null

Errors

StatusCodeWhen and what to do
400 bad_request launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it.
404 not_found No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch.
403 forbidden The license in your token has no beta access. Checked before the launch ID. Use a token upgraded onto a license with beta access.
400 unsupported_chain The launch is not on Solana. The body adds chain. Call it only for Solana launches (IDs starting with 101).
404 not_found The launch exists but is not an allowlist curve launch. Call it only for a Meteora DBC launch created with create_params.allowlist.

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

Web client proxima.launch.allowlist.status(launchId) src/lib/proxima/endpoints/launch/allowlist.ts

GET /launch/allowlist/verification/{launch_id}

Runs the run's acceptance checks against the chain and returns the report.

Token
Upgraded session token, bound to a license.
Read-only tokens
Allowed.
Retry
Safe to retry Each call reads the chain again and stores the report as the run's latest verification; nothing is sent.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

Returns ok and an Allowlist verification report object under report.

  • ok boolean
    Always true on success.
  • report object
    The verification report.
    Child attributes 12
    • ok boolean
      true when every check passes.
    • checks array<object>
      Acceptance checks read from the chain: distinct_balances, group_sum, top_ten, sol_floor, allowlist_sealed, hook_removed, authorities, migrated, liquidity_locked and creator_position_held.
      Child attributes 3
      • name string
        Check name.
      • ok boolean
        Whether the check passes.
      • detail string
        What was measured.
    • exit_estimate object | null
      Informative exit estimate; never a check.
      Child attributes 6
      • estimate boolean
        Always true: a theoretical figure, never a promise.
      • basis enum
        migration: the pool the curve opens at its threshold; pool: the migrated pool now.
        Possible values migrationpool
      • fee_bps integer
        Pool fee used, in basis points.
      • tokens string
        Tokens sold in the estimate, raw units.
      • quote_out string
        Quote the sale would bring, raw units.
      • fee string
        Fee paid on the sale, raw units.

Errors

StatusCodeWhen and what to do
400 bad_request launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it.
404 not_found No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch.
403 forbidden The license in your token has no beta access. Checked before the launch ID. Use a token upgraded onto a license with beta access.
400 unsupported_chain The launch is not on Solana. The body adds chain. Call it only for Solana launches (IDs starting with 101).
404 not_found The launch exists but is not an allowlist curve launch. Call it only for a Meteora DBC launch created with create_params.allowlist.
409 conflict The run is draft or planned, so there is nothing on chain to verify yet. Call it once the launch has started.
422 unprocessable The checks could not be read from the chain, for example an RPC read failed or an account the run created no longer exists. Retry in a few seconds; the last stored report stays available as verification in Retrieve allowlist run status.

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

Web client proxima.launch.allowlist.verification(launchId) src/lib/proxima/endpoints/launch/allowlist.ts