Skip to main content

Get Coins

GET 

/coins

Gets information about coins

Request

Query Parameters

    mint string[]

    The mint addresses of the coins

    owner_id string[]

    The user IDs of artists with minted coins

    ticker string[]

    The tickers of the coins

    query string

    Search by the coin name or ticker

    offset integer

    Default value: 0

    The number of items to skip. Useful for pagination (page number * limit)

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 50

    The number of items to fetch

    sort_method string

    Possible values: [market_cap, volume, price, created_at, holder]

    Default value: market_cap

    Field to use for sorting the results

    sort_direction string

    Possible values: [asc, desc]

    Default value: desc

    The sort direction

Responses

Success

Schema

    data

    object[]

    required

  • Array [

  • name stringrequired

    The coin name

    ticker string

    The coin symbol

    mint stringrequired

    The coin mint address

    decimals integerrequired

    The number of decimals for the coin

    owner_id stringrequired

    The ID of the user associated with the coin

    escrow_recipient string

    The escrow recipient address for custom-created coins without DBCs

    logo_uri string

    URL to the coin's logo image

    banner_image_url string

    URL to the coin's banner image

    description string

    A longform description about the coin

    website string

    The official website for the coin

    link_1 string

    Generic link URL for the coin

    link_2 string

    Generic link URL for the coin

    link_3 string

    Generic link URL for the coin

    link_4 string

    Generic link URL for the coin

    has_discord booleanrequired

    Whether the coin has a Discord server

    created_at stringrequired

    The date and time when the coin was added to Audius.

    address string

    The SPL token mint address

    symbol string

    The token symbol

    marketCap numberrequired

    Market capitalization in USD

    fdv numberrequired

    Fully diluted valuation in USD

    extensions

    object

    Token metadata and links

    coingeckoId string

    CoinGecko ID

    description string

    Token description

    twitter string

    Twitter URL

    website string

    Website URL

    discord string

    Discord invite URL

    liquidity numberrequired

    Current liquidity in USD

    lastTradeUnixTime integerrequired

    Unix timestamp of the last trade

    lastTradeHumanTime stringrequired

    ISO8601 time of the last trade

    price numberrequired

    Current price in USD

    history24hPrice numberrequired

    Price 24 hours ago in USD

    priceChange24hPercent numberrequired

    24h price change in percent

    uniqueWallet24h integerrequired

    Unique wallets traded in last 24h

    uniqueWalletHistory24h integerrequired

    Unique wallets traded in previous 24h

    uniqueWallet24hChangePercent numberrequired

    24h change in unique wallets (percent)

    totalSupply numberrequired

    Total supply of the token

    circulatingSupply numberrequired

    Circulating supply of the token

    holder integerrequired

    Number of holders

    trade24h integerrequired

    Number of trades in last 24h

    tradeHistory24h integerrequired

    Number of trades in previous 24h

    trade24hChangePercent numberrequired

    24h change in trade count (percent)

    sell24h integerrequired

    Number of sell trades in last 24h

    sellHistory24h integerrequired

    Number of sell trades in previous 24h

    sell24hChangePercent numberrequired

    24h change in sell trades (percent)

    buy24h integerrequired

    Number of buy trades in last 24h

    buyHistory24h integerrequired

    Number of buy trades in previous 24h

    buy24hChangePercent numberrequired

    24h change in buy trades (percent)

    v24h numberrequired

    24h trading volume (token units)

    v24hUSD numberrequired

    24h trading volume in USD

    vHistory24h numberrequired

    Previous 24h trading volume (token units)

    vHistory24hUSD number

    Previous 24h trading volume in USD

    v24hChangePercent number

    24h change in volume (percent)

    vBuy24h number

    24h buy volume (token units)

    vBuy24hUSD number

    24h buy volume in USD

    vBuyHistory24h number

    Previous 24h buy volume (token units)

    vBuyHistory24hUSD number

    Previous 24h buy volume in USD

    vBuy24hChangePercent number

    24h change in buy volume (percent)

    vSell24h number

    24h sell volume (token units)

    vSell24hUSD number

    24h sell volume in USD

    vSellHistory24h number

    Previous 24h sell volume (token units)

    vSellHistory24hUSD number

    Previous 24h sell volume in USD

    vSell24hChangePercent number

    24h change in sell volume (percent)

    numberMarkets integer

    Number of markets the token is traded on

    totalVolume numberrequired

    Total volume of coin traded (all time)

    totalVolumeUSD numberrequired

    Total volume of coin traded in USD (all time)

    volumeBuy numberrequired

    Total volume bought (all time)

    volumeBuyUSD numberrequired

    Total volume bought in USD (all time)

    volumeSell numberrequired

    Total volume sold (all time)

    volumeSellUSD numberrequired

    Total volume sold in USD (all time)

    totalTrade integerrequired

    Total number of trades (all time)

    buy integerrequired

    Total number of buys (all time)

    sell integerrequired

    Total number of sells (all time)

    dynamicBondingCurve

    object

    required

    Information about the dynamic bonding curve if one exists for the Coin

    address stringrequired

    Address of the bonding curve pool

    price numberrequired

    Current price in the pool's quote token (e.g., AUDIO)

    priceUSD numberrequired

    Current price in USD

    curveProgress numberrequired

    Progress along the bonding curve (0.0 - 1.0)

    isMigrated boolean

    Whether the bonding curve has been migrated

    creatorQuoteFee numberrequired

    Creator quote fee for the bonding curve

    totalTradingQuoteFee numberrequired

    Total trading quote fee accumulated

    creatorWalletAddress stringrequired

    Address of the pool creator's wallet

    artist_fees

    object

    Information about the fees earned by the artist on the coin's trading.

    unclaimed_fees number

    Total unclaimed fees from all sources, in $AUDIO.

    total_fees number

    Total fees earned from all sources, in $AUDIO.

    artist_locker

    object

    Information about the artist locker associated with the coin.

    address string

    The address of the artist locker.

    locked number

    The amount currently locked in the artist locker.

    unlocked number

    The amount currently unlocked in the artist locker.

    claimable number

    The amount claimable from the artist locker. Eg. the amount unlocked that hasn't already been claimed.

    reward_pool

    object

    Information about the reward pool associated with the coin.

    address string

    The address of the reward pool.

    balance number

    The current balance of the reward pool.

  • ]

Loading...