meteora

README

Meteora Go SDK

Go client library for the Meteora REST APIs. Covers all five Meteora services with a unified client and zero external dependencies (only net/http).

Installation

go get github.com/ua1984/meteora-go

Note: Versions below v1.2.0 contain known issues and should be avoided. Always use v1.2.0 or later.

Quick Start

package main

import (
	"context"
	"fmt"
	"log"

	meteora "github.com/ua1984/meteora-go"
	"github.com/ua1984/meteora-go/dlmm"
)

func main() {
	client := meteora.New()
	ctx := context.Background()

	page, pageSize := 1, 5
	pools, err := client.DLMM.ListPools(ctx, &dlmm.ListPoolsParams{
		Page:     &page,
		PageSize: &pageSize,
	})
	if err != nil {
		log.Fatal(err)
	}

	for _, p := range pools.Data {
		fmt.Printf("%s - TVL: $%.2f\n", p.Name, p.TVL)
	}
}

See examples/basic for a full working example covering all services.

Services

The unified meteora.Client exposes five service clients:

Field	Package	Description
DLMM	dlmm	Dynamic Liquidity Market Maker - concentrated liquidity with discrete price bins
DAMMv2	dammv2	Dynamic AMM v2 - constant-product AMM with vested liquidity and alpha vaults
DAMMv1	dammv1	Dynamic AMM v1 - original AMM with multitoken pools, farming, and stable swaps
Stake2Earn	stake2earn	Fee vaults where users stake LP tokens to earn trading fees
DynamicVault	dynamicvault	Auto-yield vaults allocating tokens across lending protocols

DLMM

Base URL: https://dlmm.datapi.meteora.ag (30 req/s)

client.DLMM.ListPools(ctx, params)                           // Paginated pool listing with search/sort/filter
client.DLMM.ListGroups(ctx, params)                          // Pool groups by token pair
client.DLMM.GetGroup(ctx, mints, params)                     // Pools in a specific group
client.DLMM.GetPool(ctx, address)                            // Single pool by address
client.DLMM.GetOHLCV(ctx, address, params)                   // Candlestick data (1m, 5m, 15m, 1h, 4h, 1d)
client.DLMM.GetVolumeHistory(ctx, addr, params)              // Volume history
client.DLMM.GetProtocolMetrics(ctx)                          // Protocol-wide stats (TVL, volume, fees)
client.DLMM.GetClosedPositions(ctx, wallet, params)          // Closed positions for a wallet
client.DLMM.GetOpenPositions(ctx, wallet, params)            // Open positions grouped by pool for a wallet
client.DLMM.GetPositionHistoricalEvents(ctx, address, params) // Historical events for a position
client.DLMM.GetPositionTotalClaimFees(ctx, address)          // Total claim fees for a position
client.DLMM.GetPoolPositionPnL(ctx, poolAddress, params)     // Positions with PnL for a pool
client.DLMM.GetPortfolio(ctx, params)                        // User portfolio with pool metadata and PnL
client.DLMM.GetOpenPortfolio(ctx, params)                    // User open portfolio with balances
client.DLMM.GetPortfolioTotal(ctx, user)                     // All-time total PnL across user's pools

DAMM v2

Base URL: https://damm-v2.datapi.meteora.ag (10 req/s)

client.DAMMv2.ListPools(ctx, params)                        // Paginated pool listing
client.DAMMv2.ListGroups(ctx, params)                       // Pool groups by token pair
client.DAMMv2.GetGroup(ctx, mints, params)                  // Pools in a specific group
client.DAMMv2.GetPool(ctx, address)                         // Single pool by address
client.DAMMv2.GetOHLCV(ctx, address, params)                // Candlestick data
client.DAMMv2.GetVolumeHistory(ctx, addr, params)           // Volume history
client.DAMMv2.GetProtocolMetrics(ctx)                       // Protocol-wide stats
client.DAMMv2.GetClosedPositions(ctx, wallet, params)       // Closed positions for a wallet
client.DAMMv2.GetOpenPositions(ctx, wallet, params)         // Open positions grouped by pool for a wallet

DAMM v1

Base URL: https://amm-v2.meteora.ag (10 req/s)

client.DAMMv1.ListPools(ctx, params)           // All pools with optional filtering
client.DAMMv1.SearchPools(ctx, params)         // Search with required pagination and filtering/sorting
client.DAMMv1.GetPoolsMetrics(ctx)             // Protocol-level aggregate metrics
client.DAMMv1.ListPoolConfigs(ctx)             // All pool configurations
client.DAMMv1.GetFeeConfig(ctx, configAddr)    // Fee config by address
client.DAMMv1.ListPoolsWithFarm(ctx, params)   // Pools with active farming
client.DAMMv1.ListAlphaVaults(ctx, params)     // Alpha vaults, optionally filtered by vault/pool address or base mint
client.DAMMv1.ListAlphaVaultConfigs(ctx)       // Alpha vault configs (prorata and FCFS)
client.DAMMv1.GetPoolsByVaultLP(ctx, address)  // Pools by vault LP address

Stake2Earn

Base URL: https://stake-for-fee-api.meteora.ag

client.Stake2Earn.GetAnalytics(ctx)           // Protocol-wide stats
client.Stake2Earn.ListVaults(ctx)             // All vaults
client.Stake2Earn.FilterVaults(ctx, params)   // Filter vaults by pool addresses
client.Stake2Earn.GetVault(ctx, address)      // Single vault by address

Dynamic Vault

Base URL: https://merv2-api.meteora.ag

client.DynamicVault.ListVaultInfo(ctx)                       // All vaults with state, APY, strategies
client.DynamicVault.ListVaultAddresses(ctx)                  // Vault addresses (vault, LP mint, fee)
client.DynamicVault.GetVaultState(ctx, tokenMint)            // Current vault state
client.DynamicVault.GetAPYState(ctx, tokenMint)              // APY breakdown by strategy
client.DynamicVault.GetAPYByTimeRange(ctx, mint, start, end) // Historical APY
client.DynamicVault.GetVirtualPrice(ctx, mint, strategy)     // Virtual price history

Configuration

// Default client
client := meteora.New()

// Custom HTTP client
client := meteora.New(
	meteora.WithHTTPClient(&http.Client{Timeout: 10 * time.Second}),
)

// Override base URLs
client := meteora.New(
	meteora.WithDLMMBaseURL("https://custom-dlmm.example.com"),
	meteora.WithDAMMv2BaseURL("https://custom-damm.example.com"),
)

Available options: WithHTTPClient, WithDLMMBaseURL, WithDAMMv2BaseURL, WithDAMMv1BaseURL, WithStake2EarnBaseURL, WithDynamicVaultBaseURL.

Error Handling

Non-2xx HTTP responses are returned as *httpclient.APIError:

pools, err := client.DLMM.ListPools(ctx, nil)
if err != nil {
	var apiErr *httpclient.APIError
	if errors.As(err, &apiErr) {
		fmt.Printf("HTTP %d: %s\n", apiErr.StatusCode, apiErr.Body)
	}
}

Requirements

• Go 1.21 or later

License

See LICENSE file for details.

Documentation

Overview

Package meteora provides a Go client library for the Meteora REST APIs.

Index

• func Bool(b bool) *bool
• func Int(i int) *int
• func String(s string) *string
• type Client
  • func New(opts ...Option) *Client
• type Option
  • func WithDAMMv1BaseURL(u string) Option
  • func WithDAMMv2BaseURL(u string) Option
  • func WithDLMMBaseURL(u string) Option
  • func WithDynamicVaultBaseURL(u string) Option
  • func WithHTTPClient(c *http.Client) Option
  • func WithStake2EarnBaseURL(u string) Option

Functions

func Bool

func Bool(b bool) *bool

Bool returns a pointer to the bool value.

func Int

func Int(i int) *int

Int returns a pointer to the int value.

func String

func String(s string) *string

String returns a pointer to the string value.

Types

type Client

type Client struct {
	DLMM         *dlmm.Client
	DAMMv2       *dammv2.Client
	DAMMv1       *dammv1.Client
	Stake2Earn   *stake2earn.Client
	DynamicVault *dynamicvault.Client
}

Client provides access to all Meteora API services.

func New

func New(opts ...Option) *Client

New creates a new Meteora API client with the given options.

type Option

type Option func(*options)

Option configures the Client.

func WithDAMMv1BaseURL

func WithDAMMv1BaseURL(u string) Option

WithDAMMv1BaseURL overrides the DAMM v1 API base URL.

func WithDAMMv2BaseURL

func WithDAMMv2BaseURL(u string) Option

WithDAMMv2BaseURL overrides the DAMM v2 datapi base URL.

func WithDLMMBaseURL

func WithDLMMBaseURL(u string) Option

WithDLMMBaseURL overrides the DLMM datapi base URL.

func WithDynamicVaultBaseURL

func WithDynamicVaultBaseURL(u string) Option

WithDynamicVaultBaseURL overrides the Dynamic Vault API base URL.

func WithHTTPClient

func WithHTTPClient(c *http.Client) Option

WithHTTPClient sets a custom http.Client for all API requests.

func WithStake2EarnBaseURL

func WithStake2EarnBaseURL(u string) Option

WithStake2EarnBaseURL overrides the Stake2Earn API base URL.