Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.meteora.ag/llms.txt

Use this file to discover all available pages before exploring further.

The Stake2Earn Data API exposes read-only indexed data for Stake2Earn vault discovery, aggregate analytics, vault filters, and leaderboard views.
The checked-in Stake2Earn OpenAPI file does not declare a rate limit. Treat the API as a read-only discovery and dashboard source, and use on-chain stake_for_fee accounts as the source of truth for transaction construction.

Base URLs

EnvironmentBase URLSwagger UI
Productionhttps://stake-for-fee-api.meteora.agOpen
Devnethttps://devnet.stake-for-fee-api.meteora.agOpen
The checked-in OpenAPI file is based on the production Swagger spec. The production spec references a vault-detail schema that is omitted from the live components; the local checked-in file includes the observed production vault-detail response fields so generated docs can resolve the endpoint.

Analytics

get_all_analytics

Returns aggregate Stake2Earn counts and USD stake totals using GET /analytics/all

Vaults

get_all_vaults

Returns all indexed Stake2Earn vaults using GET /vault/all

filter_vaults

Returns vaults filtered by pool address using GET /vault/filter

get_one_vault

Returns one vault and its top-list holders using GET /vault/{vault_address}

Query Parameters

EndpointParameterMeaning
/vault/filterpool_addressOptional array of pool addresses. Production spec documents a maximum of 100 pool addresses.
/vault/{vault_address}vault_addressStake2Earn fee vault address.

Common Vault Fields

Vault list responses include:
FieldMeaning
vault_addressStake2Earn FeeVault account address.
pool_addressDAMM v1 pool linked to the vault.
token_a_mint, token_b_mintDAMM v1 pool token mints.
stake_mintMint users stake in this vault.
token_a_symbol, token_b_symbolIndexed token display symbols when available.
total_staked_amountIndexed total stake amount in decimalized token units.
total_staked_amount_usdIndexed USD value of total stake.
current_reward_token_a_usd, current_reward_token_b_usdIndexed reward values by pool token.
current_reward_usdCombined indexed reward value.
daily_reward_usdEstimated daily reward based on indexed data.
created_at_slot, created_at_slot_timestamp, created_at_tx_sigCreation slot, timestamp, and transaction signature.
seconds_to_full_unlockFee drip duration from vault configuration.
start_fee_distribute_timestampTimestamp when fee distribution begins.
marketcapIndexed market cap value when available.
flagsAPI flags such as TVL threshold status.

Vault Detail Fields

GET /vault/{vault_address} returns the common vault fields plus top_lists.
FieldMeaning
top_listsArray of top-list holder entries for the vault.
ownerHolder wallet address.
staked_amountHolder stake amount in decimalized token units.
token_a_accumulated_reward, token_b_accumulated_rewardIndexed accumulated rewards by pool token.
token_a_accumulated_reward_usd, token_b_accumulated_reward_usdIndexed USD values for accumulated rewards.
daily_reward_usdHolder’s estimated daily reward.

API Or On-Chain Data

NeedUse
Vault discovery and dashboardsData API /vault/all, /vault/filter, /vault/{vault_address}.
Aggregate product metricsData API /analytics/all.
Transaction constructionOn-chain FeeVault, DAMM v1 pool, lock escrow, Dynamic Vault, token vault, and list accounts.
Claimable fee executionTypeScript SDK or CPI with fresh on-chain state and simulation.
Leaderboard displayData API for indexed display, on-chain top/full list accounts for execution-sensitive ranking.