# Bags API Documentation

## Docs

- [Bags API Documentation](https://docs.bags.fm/index.md): Build powerful applications with the Bags API - get started with authentication, rate limits, and your first API call
- [Install and Set Up the Bags CLI](https://docs.bags.fm/cli/install-and-setup.md): Install the Bags CLI, configure your wallet and RPC, authenticate, and start using terminal-based workflows
- [Quickstart: Launch a Token](https://docs.bags.fm/cli/quickstart-token-launch.md): Go from zero to a live token on Solana in three commands using the Bags CLI
- [CLI Command Reference](https://docs.bags.fm/cli/command-reference.md): Complete reference for every Bags CLI command, subcommand, flag, and option
- [Set Up a TypeScript & Node.js Project](https://docs.bags.fm/how-to-guides/typescript-node-setup.md): Follow these steps to set up a TypeScript and Node.js project for interacting with the Bags API.
- [Launch a Token](https://docs.bags.fm/how-to-guides/launch-token.md): Complete step-by-step guide to launch a Solana token using the Bags API v2 with TypeScript and Node.js
- [Create a Launch Intent URL](https://docs.bags.fm/how-to-guides/create-launch-intent.md): Build shareable launch intent URLs that pre-fill the Bags /launch form and embed them as buttons on any webpage
- [Create Partner Key](https://docs.bags.fm/how-to-guides/create-partner-key.md): Complete guide to create a partner key for fee sharing using the Bags Dev Dashboard or SDK
- [Claim Partner Fees](https://docs.bags.fm/how-to-guides/claim-partner-fees.md): Complete guide to claim fees from partner configurations using the Bags Dev Dashboard or SDK
- [Get Token Lifetime Fees](https://docs.bags.fm/how-to-guides/get-token-lifetime-fees.md): Learn how to retrieve the total lifetime fees earned by a Solana token using the Bags API with TypeScript and Node.js
- [Get Token Creators](https://docs.bags.fm/how-to-guides/get-token-creators.md): Learn how to retrieve token launch creators/deployers with provider details using the Bags TypeScript SDK and Node.js
- [Claim Token Fees](https://docs.bags.fm/how-to-guides/claim-fees.md): Complete guide to claim fees for a token using the Bags API with TypeScript and Node.js
- [Trade Tokens](https://docs.bags.fm/how-to-guides/trade-tokens.md): Complete guide to get trade quotes and execute token swaps using the Bags API with TypeScript and Node.js
- [Initial Buy Math](https://docs.bags.fm/how-to-guides/initial-buy-math.md): Calculate how many tokens you receive for your initial buy using the Meteora Dynamic Bonding Curve SDK
- [Get Token Claim Events](https://docs.bags.fm/how-to-guides/get-token-claim-events.md): Learn how to retrieve claim events for a token using both offset pagination and time-based filtering
- [Customize Token Fees](https://docs.bags.fm/how-to-guides/customize-token-fees.md): Learn how to configure different fee structures for your token launch using Bags config types
- [Agent Authentication and Skill Workflow](https://docs.bags.fm/how-to-guides/agent-authentication.md): How AI agents authenticate with wallet signatures, obtain API keys, and use the Bags skill endpoint workflow
- [Base URL & Versioning](https://docs.bags.fm/principles/base-url-versioning.md): API endpoint structure and versioning information
- [Program IDs](https://docs.bags.fm/principles/program-ids.md): Solana programs used by Bags and where to find their IDLs
- [Address Lookup Tables (LUTs)](https://docs.bags.fm/principles/lookup-tables.md): Public LUTs maintained by Bags and how to use them
- [Priority Fees and Tips](https://docs.bags.fm/principles/tipping.md): How to optionally add tips to supported endpoints
- [Error Handling](https://docs.bags.fm/principles/error-handling.md): Understanding API error responses and status codes
- [Rate Limits](https://docs.bags.fm/principles/rate-limits.md): Understanding API rate limits and monitoring usage
- [File Upload Support](https://docs.bags.fm/principles/file-uploads.md): How to upload images and files through the Bags API
- [API Key Management](https://docs.bags.fm/principles/api-key-management.md): Best practices for creating, organizing, and securing your API keys
- [Robinhood Chain Overview](https://docs.bags.fm/robinhood/overview.md): How the Bags protocol works on Robinhood Chain: token lifecycle, fees, chain facts, and the full contract address book for third-party integrators.
- [Environment Setup](https://docs.bags.fm/robinhood/setup.md): Set up viem clients, the Robinhood Chain definition, contract addresses, and ABIs before integrating Bags launching and trading.
- [Launch a Token](https://docs.bags.fm/robinhood/launch-token.md): Launch a Bags token on Robinhood Chain by calling the BagsFactory directly with viem, with an optional atomic initial buy and configurable fee claimers.
- [Trade Tokens](https://docs.bags.fm/robinhood/trade-tokens.md): Buy and sell Bags tokens on Robinhood Chain: bonding-curve trades before graduation and Uniswap v4 swaps (via the modified UniversalRouter) after.
- [Read State & Discover Tokens](https://docs.bags.fm/robinhood/read-state.md): Query Bags token state with BagsLens, discover tokens through the factory registry and TokenCreated events, derive pool IDs, and read post-migration prices.
- [Claim Creator Fees](https://docs.bags.fm/robinhood/claim-fees.md): Understand the Bags fee-share model on Robinhood Chain and claim accrued creator fees from a token's BagsFeeShare contract with viem.
- [Launch an Index Token](https://docs.bags.fm/robinhood/index-tokens.md): Launch a dividend coin on Robinhood Chain whose creator fees automatically buy a basket of tokenized assets and pay them out to holders, then register and monitor it through the Bags API.
- [Partner Program](https://docs.bags.fm/robinhood/partner-program.md): Earn a share of trading fees as a Robinhood Chain launch partner: how partner economics work, how to launch with a partner, track your tokens, and claim earnings.
- [Contracts Reference](https://docs.bags.fm/robinhood/contracts.md): Reference for the Bags smart contracts on Robinhood Chain: roles, addresses, key functions and events, custom errors, and ABI downloads.
- [API Reference](https://docs.bags.fm/api-reference/introduction.md): Complete documentation for all Bags API endpoints
- [Get Current User Info](https://docs.bags.fm/api-reference/get-auth-me.md): Returns information about the user that owns the provided public API key.
- [Initialize Agent Authentication](https://docs.bags.fm/api-reference/agent-auth-init.md): Generate a signable challenge message and nonce for wallet-signature based agent authentication.
- [Complete Agent Authentication Callback](https://docs.bags.fm/api-reference/agent-auth-callback.md): Submit either a wallet signature callback payload or an MFA callback payload to receive an API key.
- [Get Token Launch Feed](https://docs.bags.fm/api-reference/get-token-launch-feed.md): Retrieve the token launch feed containing recent and active token launches with their current status.
- [Create Token Info and Metadata](https://docs.bags.fm/api-reference/create-token-info.md): Create token information with image upload and generate a token mint that can be used to launch a token
- [Create Token Launch Transaction](https://docs.bags.fm/api-reference/create-token-launch-transaction.md): Create a token launch transaction (already signed with token mint)
- [Get Fee Share Wallet V2](https://docs.bags.fm/api-reference/get-fee-share-wallet.md): Get the wallet address associated with a social provider and username for fee sharing. The optional `chain` parameter selects which chain to resolve the wallet on: `SOL` (default) returns the user's Solana embedded wallet, while `EVM` resolves (and creates if needed) the user's Ethereum embedded wal…
- [Get Fee Share Wallet V2 (Bulk)](https://docs.bags.fm/api-reference/get-fee-share-wallet-bulk.md): Bulk lookup of wallet addresses associated with social providers and usernames for fee sharing. Each item accepts an optional `chain` (`SOL` default, or `EVM`); the resolved `chain` is echoed back on every result. Deduplication is performed on `username + provider + chain`, so the same handle may ap…
- [Create Fee Share Config creation transaction](https://docs.bags.fm/api-reference/create-fee-share-configuration.md): Create a fee sharing config with multiple fee claimers (up to 100). Token Launches require fee sharing configuration for all token launches. All fees must be explicitly allocated using basis points. When there are more than 15 fee claimers, lookup tables are required.
- [Get Fee Share Admin List](https://docs.bags.fm/api-reference/get-fee-share-admin-list.md): Returns a list of token mints where the given wallet is the fee share admin.
- [Create Fee Share Admin Transfer Transaction](https://docs.bags.fm/api-reference/create-fee-share-admin-transfer-tx.md): Creates a transaction to transfer fee share admin authority from the current admin to a new admin for a given token.
- [Create Fee Share Admin Update Config](https://docs.bags.fm/api-reference/create-fee-share-admin-update-config.md): Creates transactions to update the fee share configuration for a token. Allows the admin to change the fee claimers and their basis point allocations.
- [Get Token Launch Creators](https://docs.bags.fm/api-reference/get-token-launch-creators.md): Retrieve the creators/deployers of a specific token launch. Use the 'provider' field to show a platform logo in your UI, and prefer 'providerUsername' for display when present since 'username' is a Bags internal username and optional.
- [Get Token Lifetime Fees](https://docs.bags.fm/api-reference/get-token-lifetime-fees.md): Retrieve the total lifetime fees collected for a specific token
- [Get Token Claim Stats](https://docs.bags.fm/api-reference/get-token-claim-stats.md): Retrieve claim statistics for all fee claimers of a specific token, including total claimed amounts per user.
- [Get Token Claim Events](https://docs.bags.fm/api-reference/get-token-claim-events.md): Retrieve claim events for a specific token. Supports two query modes:
- [Get Pool Config Keys by Fee Claimer Vaults](https://docs.bags.fm/api-reference/get-pool-config-keys.md): Given a list of fee claimer vault public keys, returns the first Meteora DBC pool config key for each if present.
- [Get Bags Pools](https://docs.bags.fm/api-reference/get-bags-pools.md): Retrieve a list of all Bags pools with their associated Meteora DBC and DAMM v2 pool keys
- [Get Bags Pool by Token Mint](https://docs.bags.fm/api-reference/get-bags-pool-by-token-mint.md): Retrieve a single Bags pool by its token mint address, with its associated Meteora DBC and DAMM v2 pool keys
- [Get Claim Transactions (v3)](https://docs.bags.fm/api-reference/get-claim-transactions-v3.md): Generate transactions to claim fees for a token. This simplified v3 endpoint automatically handles all fee claiming logic based on the token state.
- [Get Claimable Positions](https://docs.bags.fm/api-reference/get-claimable-positions.md): Retrieve all claimable fee positions for a wallet. Returns positions with fee information from virtual pools and DAMM v2.
- [Get Trade Quote](https://docs.bags.fm/api-reference/get-trade-quote.md): Get a quote for swapping tokens. Returns expected output amount, price impact, slippage, and route plan.
- [Create Swap Transaction](https://docs.bags.fm/api-reference/create-swap-transaction.md): Create a swap transaction from a trade quote. The transaction is ready to be signed and sent.
- [Get Partner Stats](https://docs.bags.fm/api-reference/get-partner-stats.md): Retrieve partner statistics including claimed and unclaimed fees for a given partner
- [Create Partner Claim Transactions](https://docs.bags.fm/api-reference/get-partner-claim-transactions.md): Generate transactions to claim accumulated partner fees
- [Create Partner Config](https://docs.bags.fm/api-reference/create-partner-configuration.md): Get a transaction to create a partner key (partner config) for fee sharing. Only one partner key can be created per wallet.
- [Send Transaction](https://docs.bags.fm/api-reference/send-transaction.md): Submit a signed Bags Solana transaction to the network for execution.
- [Get EVM Token Creators](https://docs.bags.fm/api-reference/get-evm-token-creator.md): Resolve the creator and fee-share claimers of a Bags EVM token, enriched with Bags social profile data (username, pfp, connected social provider).
- [Get Robinhood Token List](https://docs.bags.fm/api-reference/get-rh-tokens.md): Get a paged list of Bags V2 tokens on Robinhood Chain with live enrichment (spot price and bonding progress). Each item carries `priceEthPerToken` (nullable) and `bondingProgressPct`, plus resolved `metadata` (image, description).
- [Get Robinhood Token](https://docs.bags.fm/api-reference/get-rh-token.md): Get a single Bags V2 token on Robinhood Chain: indexed data plus live on-chain state.
- [Get Robinhood Token State](https://docs.bags.fm/api-reference/get-rh-token-state.md): Get live on-chain state for a Bags V2 token on Robinhood Chain (via the V2 lens), with no subgraph dependency. Returns `404` for non-V2 tokens.
- [Get Robinhood Token Creations](https://docs.bags.fm/api-reference/get-rh-token-creations.md): Get recently launched Bags V2 tokens on Robinhood Chain, newest first.
- [Get Robinhood Trade History](https://docs.bags.fm/api-reference/get-rh-trades.md): Get trade history for a Bags V2 token on Robinhood Chain, newest first, using a compound keyset cursor. Every page respects `limit` (never over-returns), and ties within a busy second are never skipped.
- [Get Robinhood Trade Stats](https://docs.bags.fm/api-reference/get-rh-trade-stats.md): Get a server-side trade aggregate for a Bags V2 token on Robinhood Chain over a rolling window (volume, transaction counts, last price).
- [Get Robinhood Creator Fees](https://docs.bags.fm/api-reference/get-rh-creator-fees.md): Get lifetime and pending fees for a Bags V2 token on Robinhood Chain. Lifetime figures are summed from subgraph fee notifications; the pending leg is the hook's un-swept accrual. Lifetime earnings for display = notified sums + pending. Returns `404` for non-V2 tokens.
- [Get Robinhood Creator Roster](https://docs.bags.fm/api-reference/get-rh-creator-roster.md): Get the full fee-share roster for a Bags V2 token on Robinhood Chain — every recipient with claimed, claimable, and estimated pending amounts. Combines the fee-share claimer list, live claimable per recipient, the partner and rate from the hook snapshot, per-recipient claim sums from the subgraph, a…
- [Get Robinhood Creator Earnings](https://docs.bags.fm/api-reference/get-rh-creator-earnings.md): Get a single user's earnings view for a Bags V2 token on Robinhood Chain: claimer/partner status, claimable, claimed, and estimated pending amounts. Returns `404` for non-V2 tokens.
- [Get Robinhood Swap Quote](https://docs.bags.fm/api-reference/get-rh-quote.md): Get a display-only swap quote for a Bags V2 token on Robinhood Chain. Pre-migration quotes come from the bonding curve; post-migration quotes come from the Uniswap V4 Quoter. **Exact-in only** — exact-out is not supported.
- [Get Robinhood Pool Price](https://docs.bags.fm/api-reference/get-rh-pool-price.md): Get the live Uniswap V4 pool spot price for a migrated Bags V2 token on Robinhood Chain (read from the pool's slot0). `priceEthPerToken` is `null` for non-migrated tokens or when the pool read is unavailable — render as "unavailable", never `0`. Returns `404` for non-V2 tokens.
- [Get Robinhood Balances](https://docs.bags.fm/api-reference/get-rh-balances.md): Get an owner's ETH and WETH balances on Robinhood Chain — plus an optional token balance — in one round-trip.
- [Get Robinhood Portfolio](https://docs.bags.fm/api-reference/get-rh-portfolio.md): Get an owner's Bags V2 portfolio on Robinhood Chain.
- [Get Robinhood Claimable Positions](https://docs.bags.fm/api-reference/get-rh-claimable-positions.md): Get every Robinhood Chain fee position the owner can act on across V1 and V2 tokens. Each position includes already-notified claimable WETH, the owner's estimated share of un-swept hook fees, lifetime claimed amounts, and claimer or partner eligibility.
- [Create Robinhood Claim Transactions](https://docs.bags.fm/api-reference/create-rh-claim-txs.md): Create unsigned EVM transactions for an owner to claim a Robinhood Chain token's accrued fees as native ETH. The response includes the current claimable and estimated pending amounts used to build the transaction.
- [Get Robinhood Creation Fee](https://docs.bags.fm/api-reference/get-rh-creation-fee.md): Get the current token creation fee on the Bags V2 factory on Robinhood Chain.
- [Get Robinhood Top Volume](https://docs.bags.fm/api-reference/get-rh-top-volume.md): Get the top 100 Bags V2 tokens on Robinhood Chain by lifetime volume, ranked on indexed gross trading fees. Each item carries `volumeEthWei`, the inferred lifetime ETH volume, plus the same live enrichment (`priceEthPerToken`, `bondingProgressPct`) as the token list endpoint.
- [Get Index Token History](https://docs.bags.fm/api-reference/get-rh-index-token-history.md): Get completed distribution cycles for an index token on Robinhood Chain, newest first. Each cycle covers the fee claim, the basket token buys it funded, the holder distribution (with snapshot stats), and the top 10 recipients.
- [Get Index Token Statuses](https://docs.bags.fm/api-reference/get-rh-index-token-status.md): Batch-check whether tokens on Robinhood Chain are index tokens. Returns one entry per unique input address with the index-token flag and, when applicable, the basket token addresses the index token buys and distributes.
- [Initialize Index Token](https://docs.bags.fm/api-reference/init-rh-index-token.md): Initialize a Bags V2 token on Robinhood Chain as an index token with a basket of tokens to buy and distribute. The token's on-chain creator wallet must belong to the API key's user, and the token must have the required index-token claimer configured.
- [Check Dexscreener Order Availability](https://docs.bags.fm/api-reference/get-dexscreener-order-availability.md): Check whether a Dexscreener token info order is available for a given token.
- [Create Dexscreener Order](https://docs.bags.fm/api-reference/create-dexscreener-order.md): Create a Dexscreener token info order. Returns a payment transaction that must be signed and submitted.
- [Submit Dexscreener Payment](https://docs.bags.fm/api-reference/submit-dexscreener-payment.md): Submit the signed payment transaction for a Dexscreener order.
- [Changelog](https://docs.bags.fm/changelog/changelog.md): Product updates and announcements
- [What is the Bags API?](https://docs.bags.fm/faq/what-is-bags-api.md): Learn about the Bags API and what it allows you to do
- [How do I get an API key?](https://docs.bags.fm/faq/how-to-get-api-key.md): Step-by-step guide to obtaining your Bags API key
- [How to display social profile on token page?](https://docs.bags.fm/faq/linking-wallets.md): Learn how to link your wallet to Bags to display your identity when creating tokens via API
- [What are the rate limits?](https://docs.bags.fm/faq/what-are-rate-limits.md): Understanding Bags API rate limits and how to monitor usage
- [Do I need a Solana wallet to use the API?](https://docs.bags.fm/faq/do-i-need-wallet.md): Learn about wallet requirements for using the Bags API

## OpenAPI Specs

- [openapi](https://docs.bags.fm/api-reference/openapi.json)