Let us power your NFT marketplace

Holaplex Marketplace GraphQL Docs

Contact

Holaplex Support

support@holaplex.com

API Endpoints
https://shared.holaplex.tools/v1
Version

1.0.0

Queries

activities

Response

Returns [NftActivity!]!

Arguments
Name Description
auctionHouses - [PublicKey!]!
creators - [PublicKey!] Optional list of creators

Example

Query
query activities(
  $auctionHouses: [PublicKey!]!,
  $creators: [PublicKey!]
) {
  activities(
    auctionHouses: $auctionHouses,
    creators: $creators
  ) {
    id
    metadata
    price
    createdAt
    wallets {
      ...WalletFragment
    }
    activityType
    marketplaceProgramAddress
    nft {
      ...NftFragment
    }
    auctionHouse {
      ...AuctionHouseFragment
    }
  }
}
Variables
{
  "auctionHouses": [PublicKey],
  "creators": [PublicKey]
}
Response
{
  "data": {
    "activities": [
      {
        "id": Uuid,
        "metadata": PublicKey,
        "price": U64,
        "createdAt": DateTimeUtc,
        "wallets": [Wallet],
        "activityType": "abc123",
        "marketplaceProgramAddress": "abc123",
        "nft": Nft,
        "auctionHouse": AuctionHouse
      }
    ]
  }
}

associatedTokenAccounts

Response

Returns [AssociatedTokenAccount!]!

Arguments
Name Description
mints - [PublicKey!]!
limit - Int!
offset - Int!

Example

Query
query associatedTokenAccounts(
  $mints: [PublicKey!]!,
  $limit: Int!,
  $offset: Int!
) {
  associatedTokenAccounts(
    mints: $mints,
    limit: $limit,
    offset: $offset
  ) {
    address
    mint
    owner
    amount
  }
}
Variables
{"mints": [PublicKey], "limit": 123, "offset": 123}
Response
{
  "data": {
    "associatedTokenAccounts": [
      {
        "address": PublicKey,
        "mint": PublicKey,
        "owner": PublicKey,
        "amount": U64
      }
    ]
  }
}

auctionHouse

Response

Returns an AuctionHouse

Arguments
Name Description
address - String!

Example

Query
query auctionHouse($address: String!) {
  auctionHouse(address: $address) {
    stats {
      ...MintStatsFragment
    }
    address
    treasuryMint
    auctionHouseTreasury
    treasuryWithdrawalDestination
    feeWithdrawalDestination
    authority
    creator
    bump
    treasuryBump
    feePayerBump
    sellerFeeBasisPoints
    requiresSignOff
    canChangeSalePrice
    auctionHouseFeeAccount
    rewardCenter {
      ...RewardCenterFragment
    }
  }
}
Variables
{"address": "xyz789"}
Response
{
  "data": {
    "auctionHouse": {
      "stats": MintStats,
      "address": PublicKey,
      "treasuryMint": "xyz789",
      "auctionHouseTreasury": "abc123",
      "treasuryWithdrawalDestination": "abc123",
      "feeWithdrawalDestination": "abc123",
      "authority": "xyz789",
      "creator": "xyz789",
      "bump": 987,
      "treasuryBump": 987,
      "feePayerBump": 123,
      "sellerFeeBasisPoints": 987,
      "requiresSignOff": false,
      "canChangeSalePrice": false,
      "auctionHouseFeeAccount": "xyz789",
      "rewardCenter": RewardCenter
    }
  }
}

candyMachine

Description

Get a candy machine by the candy machine config address

Response

Returns a CandyMachine

Arguments
Name Description
address - String!

Example

Query
query candyMachine($address: String!) {
  candyMachine(address: $address) {
    address
    authority
    wallet
    tokenMint
    itemsRedeemed
    uuid
    price
    symbol
    sellerFeeBasisPoints
    maxSupply
    isMutable
    retainAuthority
    goLiveDate
    itemsAvailable
    creators {
      ...CandyMachineCreatorFragment
    }
    collectionPda {
      ...CandyMachineCollectionPdaFragment
    }
    configLines {
      ...CandyMachineConfigLineFragment
    }
    endSetting {
      ...CandyMachineEndSettingFragment
    }
    whitelistMintSetting {
      ...CandyMachineWhitelistMintSettingFragment
    }
    hiddenSetting {
      ...CandyMachineHiddenSettingFragment
    }
    gateKeeperConfig {
      ...CandyMachineGateKeeperConfigFragment
    }
  }
}
Variables
{"address": "xyz789"}
Response
{
  "data": {
    "candyMachine": {
      "address": PublicKey,
      "authority": PublicKey,
      "wallet": PublicKey,
      "tokenMint": PublicKey,
      "itemsRedeemed": U64,
      "uuid": "xyz789",
      "price": U64,
      "symbol": "xyz789",
      "sellerFeeBasisPoints": 987,
      "maxSupply": U64,
      "isMutable": false,
      "retainAuthority": false,
      "goLiveDate": U64,
      "itemsAvailable": U64,
      "creators": [CandyMachineCreator],
      "collectionPda": CandyMachineCollectionPda,
      "configLines": [CandyMachineConfigLine],
      "endSetting": CandyMachineEndSetting,
      "whitelistMintSetting": CandyMachineWhitelistMintSetting,
      "hiddenSetting": CandyMachineHiddenSetting,
      "gateKeeperConfig": CandyMachineGateKeeperConfig
    }
  }
}

candymachine

Deprecated alias for candyMachine
Response

Returns a CandyMachine

Arguments
Name Description
addr - String!

Example

Query
query candymachine($addr: String!) {
  candymachine(addr: $addr) {
    address
    authority
    wallet
    tokenMint
    itemsRedeemed
    uuid
    price
    symbol
    sellerFeeBasisPoints
    maxSupply
    isMutable
    retainAuthority
    goLiveDate
    itemsAvailable
    creators {
      ...CandyMachineCreatorFragment
    }
    collectionPda {
      ...CandyMachineCollectionPdaFragment
    }
    configLines {
      ...CandyMachineConfigLineFragment
    }
    endSetting {
      ...CandyMachineEndSettingFragment
    }
    whitelistMintSetting {
      ...CandyMachineWhitelistMintSettingFragment
    }
    hiddenSetting {
      ...CandyMachineHiddenSettingFragment
    }
    gateKeeperConfig {
      ...CandyMachineGateKeeperConfigFragment
    }
  }
}
Variables
{"addr": "xyz789"}
Response
{
  "data": {
    "candymachine": {
      "address": PublicKey,
      "authority": PublicKey,
      "wallet": PublicKey,
      "tokenMint": PublicKey,
      "itemsRedeemed": U64,
      "uuid": "xyz789",
      "price": U64,
      "symbol": "xyz789",
      "sellerFeeBasisPoints": 123,
      "maxSupply": U64,
      "isMutable": true,
      "retainAuthority": false,
      "goLiveDate": U64,
      "itemsAvailable": U64,
      "creators": [CandyMachineCreator],
      "collectionPda": CandyMachineCollectionPda,
      "configLines": [CandyMachineConfigLine],
      "endSetting": CandyMachineEndSetting,
      "whitelistMintSetting": CandyMachineWhitelistMintSetting,
      "hiddenSetting": CandyMachineHiddenSetting,
      "gateKeeperConfig": CandyMachineGateKeeperConfig
    }
  }
}

charts

Response

Returns a PriceChart!

Arguments
Name Description
auctionHouses - [PublicKey!]! List of auction houses
creators - [PublicKey!] Optional list of creators
startDate - DateTimeUtc! Start date for which we want to get the average price
endDate - DateTimeUtc! End date for which we want to get the average price

Example

Query
query charts(
  $auctionHouses: [PublicKey!]!,
  $creators: [PublicKey!],
  $startDate: DateTimeUtc!,
  $endDate: DateTimeUtc!
) {
  charts(
    auctionHouses: $auctionHouses,
    creators: $creators,
    startDate: $startDate,
    endDate: $endDate
  ) {
    listingFloor {
      ...PricePointFragment
    }
    salesAverage {
      ...PricePointFragment
    }
    totalVolume {
      ...PricePointFragment
    }
  }
}
Variables
{
  "auctionHouses": [PublicKey],
  "creators": [PublicKey],
  "startDate": DateTimeUtc,
  "endDate": DateTimeUtc
}
Response
{
  "data": {
    "charts": {
      "listingFloor": [PricePoint],
      "salesAverage": [PricePoint],
      "totalVolume": [PricePoint]
    }
  }
}

collection

Description

Returns collection data along with collection activities

Response

Returns a Collection

Arguments
Name Description
id - String! Collection ID

Example

Query
query collection($id: String!) {
  collection(id: $id) {
    id
    name
    description
    twitterUrl
    discordUrl
    websiteUrl
    magicEdenId
    verifiedCollectionAddress
    pieces
    verified
    goLiveAt
    createdAt
    updatedAt
    trends {
      ...CollectionTrendFragment
    }
    imageOriginal
    image
    nfts {
      ...NftFragment
    }
    attributeGroups {
      ...AttributeGroupFragment
    }
    holderCount
    activities {
      ...NftActivityFragment
    }
    timeseries {
      ...TimeseriesFragment
    }
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "collection": {
      "id": "abc123",
      "name": "xyz789",
      "description": "xyz789",
      "twitterUrl": "abc123",
      "discordUrl": "abc123",
      "websiteUrl": "xyz789",
      "magicEdenId": "abc123",
      "verifiedCollectionAddress": "xyz789",
      "pieces": 987,
      "verified": false,
      "goLiveAt": DateTimeUtc,
      "createdAt": DateTimeUtc,
      "updatedAt": DateTimeUtc,
      "trends": CollectionTrend,
      "imageOriginal": "abc123",
      "image": "abc123",
      "nfts": [Nft],
      "attributeGroups": [AttributeGroup],
      "holderCount": I64,
      "activities": [NftActivity],
      "timeseries": Timeseries
    }
  }
}

collectionTrends

Description

Returns featured collection NFTs ordered by market cap (floor price * number of NFTs in collection)

Response

Returns [CollectionTrend!]!

Arguments
Name Description
sortBy - CollectionSort! Choose sort for trending collections
timeFrame - CollectionInterval! The desired timeframe to evaluate the trending collection
orderDirection - OrderDirection Arrange result in ascending or descending order by selected sort_by
limit - Int! Return at most this many results
offset - Int! Return results starting from this index

Example

Query
query collectionTrends(
  $sortBy: CollectionSort!,
  $timeFrame: CollectionInterval!,
  $orderDirection: OrderDirection,
  $limit: Int!,
  $offset: Int!
) {
  collectionTrends(
    sortBy: $sortBy,
    timeFrame: $timeFrame,
    orderDirection: $orderDirection,
    limit: $limit,
    offset: $offset
  ) {
    floor1d
    floor7d
    floor30d
    volume1d
    volume7d
    volume30d
    listed1d
    listed7d
    listed30d
    lastListed1d
    lastListed7d
    lastListed30d
    lastVolume1d
    lastVolume7d
    lastVolume30d
    lastFloor1d
    lastFloor7d
    lastFloor30d
    changeFloor1d
    changeFloor7d
    changeFloor30d
    changeVolume1d
    changeVolume7d
    changeVolume30d
    changeListed1d
    changeListed7d
    changeListed30d
    collection {
      ...CollectionFragment
    }
  }
}
Variables
{
  "sortBy": "VOLUME",
  "timeFrame": "ONE_DAY",
  "orderDirection": "DESC",
  "limit": 987,
  "offset": 987
}
Response
{
  "data": {
    "collectionTrends": [
      {
        "floor1d": Numeric,
        "floor7d": Numeric,
        "floor30d": Numeric,
        "volume1d": Numeric,
        "volume7d": Numeric,
        "volume30d": Numeric,
        "listed1d": I64,
        "listed7d": I64,
        "listed30d": I64,
        "lastListed1d": I64,
        "lastListed7d": I64,
        "lastListed30d": I64,
        "lastVolume1d": Numeric,
        "lastVolume7d": Numeric,
        "lastVolume30d": Numeric,
        "lastFloor1d": Numeric,
        "lastFloor7d": Numeric,
        "lastFloor30d": Numeric,
        "changeFloor1d": 123,
        "changeFloor7d": 123,
        "changeFloor30d": 987,
        "changeVolume1d": 987,
        "changeVolume7d": 123,
        "changeVolume30d": 987,
        "changeListed1d": 123,
        "changeListed7d": 123,
        "changeListed30d": 123,
        "collection": Collection
      }
    ]
  }
}

collectionsFeaturedByMarketCap

Description

Returns featured collection NFTs ordered by market cap (floor price * number of NFTs in collection)

Response

Returns [CollectionNFT!]!

Arguments
Name Description
term - String Return collections whose metadata match this term (case insensitive); sorting occurs among limited search results (rather than searching after sorting)
orderDirection - OrderDirection! Choose (and sort) ascending or descending by market cap
startDate - DateTimeUtc! Compute market cap over NFTs listed later than this date (ISO 8601 format like 2022-07-04T17:06:10Z)
endDate - DateTimeUtc! Compute market cap over NFTs listed earlier than this date (ISO 8601 format like 2022-07-04T17:06:10Z)
limit - Int! Return at most this many results
offset - Int! Return results starting from this index

Example

Query
query collectionsFeaturedByMarketCap(
  $term: String,
  $orderDirection: OrderDirection!,
  $startDate: DateTimeUtc!,
  $endDate: DateTimeUtc!,
  $limit: Int!,
  $offset: Int!
) {
  collectionsFeaturedByMarketCap(
    term: $term,
    orderDirection: $orderDirection,
    startDate: $startDate,
    endDate: $endDate,
    limit: $limit,
    offset: $offset
  ) {
    nft {
      ...NftFragment
    }
    nfts {
      ...NftFragment
    }
    activities {
      ...NftActivityFragment
    }
    floorPrice
    holderCount
    listedCount
    nftCount
    volumeTotal
    address
    name
    sellerFeeBasisPoints
    mintAddress
    tokenAccountAddress
    primarySaleHappened
    updateAuthorityAddress
    description
    category
    parser
    image
    animationUrl
    externalUrl
    creators {
      ...NftCreatorFragment
    }
    attributes {
      ...NftAttributeFragment
    }
    owner {
      ...NftOwnerFragment
    }
    listings {
      ...AhListingFragment
    }
    purchases {
      ...PurchaseFragment
    }
    offers {
      ...OfferFragment
    }
    files {
      ...NftFileFragment
    }
    createdAt
  }
}
Variables
{
  "term": "xyz789",
  "orderDirection": "DESC",
  "startDate": DateTimeUtc,
  "endDate": DateTimeUtc,
  "limit": 987,
  "offset": 123
}
Response
{
  "data": {
    "collectionsFeaturedByMarketCap": [
      {
        "nft": Nft,
        "nfts": [Nft],
        "activities": [NftActivity],
        "floorPrice": I64,
        "holderCount": I64,
        "listedCount": U64,
        "nftCount": I64,
        "volumeTotal": U64,
        "address": "xyz789",
        "name": "abc123",
        "sellerFeeBasisPoints": 987,
        "mintAddress": "abc123",
        "tokenAccountAddress": "abc123",
        "primarySaleHappened": true,
        "updateAuthorityAddress": "xyz789",
        "description": "xyz789",
        "category": "xyz789",
        "parser": "xyz789",
        "image": "abc123",
        "animationUrl": "abc123",
        "externalUrl": "abc123",
        "creators": [NftCreator],
        "attributes": [NftAttribute],
        "owner": NftOwner,
        "listings": [AhListing],
        "purchases": [Purchase],
        "offers": [Offer],
        "files": [NftFile],
        "createdAt": DateTimeUtc
      }
    ]
  }
}

collectionsFeaturedByVolume

Description

Returns featured collection NFTs ordered by volume (sum of purchase prices)

Response

Returns [CollectionNFT!]!

Arguments
Name Description
term - String Return collections whose metadata match this term (case insensitive); sorting occurs among limited search results (rather than searching after sorting)
orderDirection - OrderDirection! Choose (and sort) ascending or descending by volume
startDate - DateTimeUtc! Compute volume over sales starting from this date (ISO 8601 format like 2022-07-04T17:06:10Z)
endDate - DateTimeUtc! Compute volume over sales ending at this date (ISO 8601 format like 2022-07-04T17:06:10Z)
limit - Int! Return at most this many results
offset - Int! Return results starting from this index

Example

Query
query collectionsFeaturedByVolume(
  $term: String,
  $orderDirection: OrderDirection!,
  $startDate: DateTimeUtc!,
  $endDate: DateTimeUtc!,
  $limit: Int!,
  $offset: Int!
) {
  collectionsFeaturedByVolume(
    term: $term,
    orderDirection: $orderDirection,
    startDate: $startDate,
    endDate: $endDate,
    limit: $limit,
    offset: $offset
  ) {
    nft {
      ...NftFragment
    }
    nfts {
      ...NftFragment
    }
    activities {
      ...NftActivityFragment
    }
    floorPrice
    holderCount
    listedCount
    nftCount
    volumeTotal
    address
    name
    sellerFeeBasisPoints
    mintAddress
    tokenAccountAddress
    primarySaleHappened
    updateAuthorityAddress
    description
    category
    parser
    image
    animationUrl
    externalUrl
    creators {
      ...NftCreatorFragment
    }
    attributes {
      ...NftAttributeFragment
    }
    owner {
      ...NftOwnerFragment
    }
    listings {
      ...AhListingFragment
    }
    purchases {
      ...PurchaseFragment
    }
    offers {
      ...OfferFragment
    }
    files {
      ...NftFileFragment
    }
    createdAt
  }
}
Variables
{
  "term": "xyz789",
  "orderDirection": "DESC",
  "startDate": DateTimeUtc,
  "endDate": DateTimeUtc,
  "limit": 987,
  "offset": 123
}
Response
{
  "data": {
    "collectionsFeaturedByVolume": [
      {
        "nft": Nft,
        "nfts": [Nft],
        "activities": [NftActivity],
        "floorPrice": I64,
        "holderCount": I64,
        "listedCount": U64,
        "nftCount": I64,
        "volumeTotal": U64,
        "address": "xyz789",
        "name": "abc123",
        "sellerFeeBasisPoints": 123,
        "mintAddress": "xyz789",
        "tokenAccountAddress": "xyz789",
        "primarySaleHappened": true,
        "updateAuthorityAddress": "abc123",
        "description": "xyz789",
        "category": "abc123",
        "parser": "abc123",
        "image": "xyz789",
        "animationUrl": "abc123",
        "externalUrl": "abc123",
        "creators": [NftCreator],
        "attributes": [NftAttribute],
        "owner": NftOwner,
        "listings": [AhListing],
        "purchases": [Purchase],
        "offers": [Offer],
        "files": [NftFile],
        "createdAt": DateTimeUtc
      }
    ]
  }
}

connections

Response

Returns [GraphConnection!]!

Arguments
Name Description
from - [PublicKey!]
to - [PublicKey!]
limit - Int!
offset - Int!

Example

Query
query connections(
  $from: [PublicKey!],
  $to: [PublicKey!],
  $limit: Int!,
  $offset: Int!
) {
  connections(
    from: $from,
    to: $to,
    limit: $limit,
    offset: $offset
  ) {
    address
    from {
      ...WalletFragment
    }
    to {
      ...WalletFragment
    }
    connectedAt
  }
}
Variables
{
  "from": [PublicKey],
  "to": [PublicKey],
  "limit": 987,
  "offset": 987
}
Response
{
  "data": {
    "connections": [
      {
        "address": "abc123",
        "from": Wallet,
        "to": Wallet,
        "connectedAt": DateTimeUtc
      }
    ]
  }
}

creator

Response

Returns a Creator!

Arguments
Name Description
address - String!

Example

Query
query creator($address: String!) {
  creator(address: $address) {
    address
    counts {
      ...CreatorCountsFragment
    }
    stats {
      ...MintStatsFragment
    }
    attributeGroups {
      ...AttributeGroupFragment
    }
    profile {
      ...TwitterProfileFragment
    }
  }
}
Variables
{"address": "abc123"}
Response
{
  "data": {
    "creator": {
      "address": "abc123",
      "counts": CreatorCounts,
      "stats": [MintStats],
      "attributeGroups": [AttributeGroup],
      "profile": TwitterProfile
    }
  }
}

denylist

Response

Returns a Denylist!

Example

Query
query denylist {
  denylist {
    storefronts
    listings
  }
}
Response
{
  "data": {
    "denylist": {
      "storefronts": [PublicKey],
      "listings": [PublicKey]
    }
  }
}

enrichedBondingChanges

Response

Returns [EnrichedBondingChange!]!

Arguments
Name Description
address - PublicKey!
startUnixTime - NaiveDateTime!
stopUnixTime - NaiveDateTime!
limit - Int!
offset - Int!

Example

Query
query enrichedBondingChanges(
  $address: PublicKey!,
  $startUnixTime: NaiveDateTime!,
  $stopUnixTime: NaiveDateTime!,
  $limit: Int!,
  $offset: Int!
) {
  enrichedBondingChanges(
    address: $address,
    startUnixTime: $startUnixTime,
    stopUnixTime: $stopUnixTime,
    limit: $limit,
    offset: $offset
  ) {
    address
    slot
    insertTs
    reserveChange
    supplyChange
  }
}
Variables
{
  "address": PublicKey,
  "startUnixTime": NaiveDateTime,
  "stopUnixTime": NaiveDateTime,
  "limit": 987,
  "offset": 123
}
Response
{
  "data": {
    "enrichedBondingChanges": [
      {
        "address": "abc123",
        "slot": U64,
        "insertTs": NaiveDateTime,
        "reserveChange": I64,
        "supplyChange": I64
      }
    ]
  }
}

featuredListings

Response

Returns [AhListing!]!

Arguments
Name Description
auctionHouses - [PublicKey!]
sellerExclusions - [PublicKey!]
limitPerSeller - Int
limit - Int!
offset - Int

Example

Query
query featuredListings(
  $auctionHouses: [PublicKey!],
  $sellerExclusions: [PublicKey!],
  $limitPerSeller: Int,
  $limit: Int!,
  $offset: Int
) {
  featuredListings(
    auctionHouses: $auctionHouses,
    sellerExclusions: $sellerExclusions,
    limitPerSeller: $limitPerSeller,
    limit: $limit,
    offset: $offset
  ) {
    id
    tradeState
    seller
    metadata
    purchaseId
    price
    tokenSize
    tradeStateBump
    createdAt
    canceledAt
    marketplaceProgramAddress
    nft {
      ...NftFragment
    }
    auctionHouse {
      ...AuctionHouseFragment
    }
  }
}
Variables
{
  "auctionHouses": [PublicKey],
  "sellerExclusions": [PublicKey],
  "limitPerSeller": 123,
  "limit": 123,
  "offset": 987
}
Response
{
  "data": {
    "featuredListings": [
      {
        "id": Uuid,
        "tradeState": "abc123",
        "seller": PublicKey,
        "metadata": PublicKey,
        "purchaseId": Uuid,
        "price": U64,
        "tokenSize": 123,
        "tradeStateBump": 123,
        "createdAt": DateTimeUtc,
        "canceledAt": DateTimeUtc,
        "marketplaceProgramAddress": "abc123",
        "nft": Nft,
        "auctionHouse": AuctionHouse
      }
    ]
  }
}

feedEvents

Description

Returns events for the wallets the user is following using the graph_program.

Response

Returns [FeedEvent!]!

Arguments
Name Description
wallet - PublicKey! A user wallet public key
limit - Int! The query record limit
offset - Int! The query record offset
excludeTypes - [String!]

Example

Query
query feedEvents(
  $wallet: PublicKey!,
  $limit: Int!,
  $offset: Int!,
  $excludeTypes: [String!]
) {
  feedEvents(
    wallet: $wallet,
    limit: $limit,
    offset: $offset,
    excludeTypes: $excludeTypes
  ) {
    ... on MintEvent {
      ...MintEventFragment
    }
    ... on OfferEvent {
      ...OfferEventFragment
    }
    ... on ListingEvent {
      ...ListingEventFragment
    }
    ... on PurchaseEvent {
      ...PurchaseEventFragment
    }
    ... on FollowEvent {
      ...FollowEventFragment
    }
  }
}
Variables
{
  "wallet": PublicKey,
  "limit": 987,
  "offset": 123,
  "excludeTypes": ["xyz789"]
}
Response
{"data": {"feedEvents": [MintEvent]}}

followWallets

Description

Recommend wallets to follow.

Response

Returns [Wallet!]!

Arguments
Name Description
wallet - PublicKey A user wallet public key
limit - Int! The query record limit
offset - Int! The query record offset

Example

Query
query followWallets(
  $wallet: PublicKey,
  $limit: Int!,
  $offset: Int!
) {
  followWallets(
    wallet: $wallet,
    limit: $limit,
    offset: $offset
  ) {
    address
    twitterHandle
    nfts {
      ...NftFragment
    }
    associatedTokenAccounts {
      ...AssociatedTokenAccountFragment
    }
    collectedCollections {
      ...CollectedCollectionFragment
    }
    activities {
      ...WalletActivityFragment
    }
    offers {
      ...OfferFragment
    }
    bids {
      ...BidFragment
    }
    profile {
      ...TwitterProfileFragment
    }
    connectionCounts {
      ...ConnectionCountsFragment
    }
    nftCounts {
      ...WalletNftCountFragment
    }
    totalRewards
  }
}
Variables
{"wallet": PublicKey, "limit": 987, "offset": 987}
Response
{
  "data": {
    "followWallets": [
      {
        "address": PublicKey,
        "twitterHandle": "abc123",
        "nfts": [Nft],
        "associatedTokenAccounts": [
          AssociatedTokenAccount
        ],
        "collectedCollections": [CollectedCollection],
        "activities": [WalletActivity],
        "offers": [Offer],
        "bids": [Bid],
        "profile": TwitterProfile,
        "connectionCounts": ConnectionCounts,
        "nftCounts": WalletNftCount,
        "totalRewards": U64
      }
    ]
  }
}

genoHabitat

Description

Query up to one Genopets habitat by the public key of its on-chain data

Response

Returns a GenoHabitat

Arguments
Name Description
address - PublicKey Select a habitat by its data account address
mint - PublicKey Select a habitat by its by mint address

Example

Query
query genoHabitat(
  $address: PublicKey,
  $mint: PublicKey
) {
  genoHabitat(
    address: $address,
    mint: $mint
  ) {
    address
    habitatMint
    level
    element
    genesis
    renewalTimestamp
    expiryTimestamp
    nextDayTimestamp
    crystalsRefined
    harvester
    kiHarvested
    seedsSpawned
    isSubHabitat
    parentHabitat
    subHabitats
    harvesterRoyaltyBips
    harvesterOpenMarket
    totalKiHarvested
    totalCrystalsRefined
    terraformingHabitat
    active
    durability
    habitatsTerraformed
    sequence
    guild
    subHabitatCooldownTimestamp
    harvesterSettingsCooldownTimestamp
    dailyKiHarvestingCap
    kiAvailableToHarvest
    hasMaxKi
    rentalAgreement {
      ...GenoRentalAgreementFragment
    }
    parentHabitatData {
      ...GenoHabitatFragment
    }
    subHabitatData {
      ...GenoHabitatFragment
    }
    nft {
      ...NftFragment
    }
  }
}
Variables
{
  "address": PublicKey,
  "mint": PublicKey
}
Response
{
  "data": {
    "genoHabitat": {
      "address": PublicKey,
      "habitatMint": PublicKey,
      "level": 987,
      "element": 123,
      "genesis": false,
      "renewalTimestamp": DateTimeUtc,
      "expiryTimestamp": DateTimeUtc,
      "nextDayTimestamp": DateTimeUtc,
      "crystalsRefined": 123,
      "harvester": "abc123",
      "kiHarvested": U64,
      "seedsSpawned": false,
      "isSubHabitat": true,
      "parentHabitat": PublicKey,
      "subHabitats": [PublicKey],
      "harvesterRoyaltyBips": 987,
      "harvesterOpenMarket": true,
      "totalKiHarvested": I64,
      "totalCrystalsRefined": I64,
      "terraformingHabitat": PublicKey,
      "active": true,
      "durability": 987,
      "habitatsTerraformed": 123,
      "sequence": I64,
      "guild": 123,
      "subHabitatCooldownTimestamp": DateTimeUtc,
      "harvesterSettingsCooldownTimestamp": DateTimeUtc,
      "dailyKiHarvestingCap": U64,
      "kiAvailableToHarvest": U64,
      "hasMaxKi": false,
      "rentalAgreement": GenoRentalAgreement,
      "parentHabitatData": GenoHabitat,
      "subHabitatData": [GenoHabitat],
      "nft": Nft
    }
  }
}

genoHabitats

Use genoHabitatsCounted instead
Response

Returns [GenoHabitat!]!

Arguments
Name Description
mints - [PublicKey!]
owners - [PublicKey!]
renters - [PublicKey!]
harvesters - [String!]
genesis - Boolean
elements - [Int!]
minLevel - Int
maxLevel - Int
minSequence - Int
maxSequence - Int
guilds - [Int!]
minDurability - Int
maxDurability - Int
minExpiry - DateTimeUtc
maxExpiry - DateTimeUtc
harvesterOpenMarket - Boolean
rentalOpenMarket - Boolean
hasAlchemist - Boolean
hasHarvester - Boolean
hasMaxKi - Boolean
isActivated - Boolean
term - String
limit - Int!
offset - Int!

Example

Query
query genoHabitats(
  $mints: [PublicKey!],
  $owners: [PublicKey!],
  $renters: [PublicKey!],
  $harvesters: [String!],
  $genesis: Boolean,
  $elements: [Int!],
  $minLevel: Int,
  $maxLevel: Int,
  $minSequence: Int,
  $maxSequence: Int,
  $guilds: [Int!],
  $minDurability: Int,
  $maxDurability: Int,
  $minExpiry: DateTimeUtc,
  $maxExpiry: DateTimeUtc,
  $harvesterOpenMarket: Boolean,
  $rentalOpenMarket: Boolean,
  $hasAlchemist: Boolean,
  $hasHarvester: Boolean,
  $hasMaxKi: Boolean,
  $isActivated: Boolean,
  $term: String,
  $limit: Int!,
  $offset: Int!
) {
  genoHabitats(
    mints: $mints,
    owners: $owners,
    renters: $renters,
    harvesters: $harvesters,
    genesis: $genesis,
    elements: $elements,
    minLevel: $minLevel,
    maxLevel: $maxLevel,
    minSequence: $minSequence,
    maxSequence: $maxSequence,
    guilds: $guilds,
    minDurability: $minDurability,
    maxDurability: $maxDurability,
    minExpiry: $minExpiry,
    maxExpiry: $maxExpiry,
    harvesterOpenMarket: $harvesterOpenMarket,
    rentalOpenMarket: $rentalOpenMarket,
    hasAlchemist: $hasAlchemist,
    hasHarvester: $hasHarvester,
    hasMaxKi: $hasMaxKi,
    isActivated: $isActivated,
    term: $term,
    limit: $limit,
    offset: $offset
  ) {
    address
    habitatMint
    level
    element
    genesis
    renewalTimestamp
    expiryTimestamp
    nextDayTimestamp
    crystalsRefined
    harvester
    kiHarvested
    seedsSpawned
    isSubHabitat
    parentHabitat
    subHabitats
    harvesterRoyaltyBips
    harvesterOpenMarket
    totalKiHarvested
    totalCrystalsRefined
    terraformingHabitat
    active
    durability
    habitatsTerraformed
    sequence
    guild
    subHabitatCooldownTimestamp
    harvesterSettingsCooldownTimestamp
    dailyKiHarvestingCap
    kiAvailableToHarvest
    hasMaxKi
    rentalAgreement {
      ...GenoRentalAgreementFragment
    }
    parentHabitatData {
      ...GenoHabitatFragment
    }
    subHabitatData {
      ...GenoHabitatFragment
    }
    nft {
      ...NftFragment
    }
  }
}
Variables
{
  "mints": [PublicKey],
  "owners": [PublicKey],
  "renters": [PublicKey],
  "harvesters": ["xyz789"],
  "genesis": true,
  "elements": [123],
  "minLevel": 123,
  "maxLevel": 123,
  "minSequence": 123,
  "maxSequence": 123,
  "guilds": [987],
  "minDurability": 987,
  "maxDurability": 123,
  "minExpiry": DateTimeUtc,
  "maxExpiry": DateTimeUtc,
  "harvesterOpenMarket": false,
  "rentalOpenMarket": false,
  "hasAlchemist": false,
  "hasHarvester": false,
  "hasMaxKi": true,
  "isActivated": true,
  "term": "xyz789",
  "limit": 123,
  "offset": 123
}
Response
{
  "data": {
    "genoHabitats": [
      {
        "address": PublicKey,
        "habitatMint": PublicKey,
        "level": 987,
        "element": 123,
        "genesis": true,
        "renewalTimestamp": DateTimeUtc,
        "expiryTimestamp": DateTimeUtc,
        "nextDayTimestamp": DateTimeUtc,
        "crystalsRefined": 123,
        "harvester": "xyz789",
        "kiHarvested": U64,
        "seedsSpawned": true,
        "isSubHabitat": false,
        "parentHabitat": PublicKey,
        "subHabitats": [PublicKey],
        "harvesterRoyaltyBips": 987,
        "harvesterOpenMarket": false,
        "totalKiHarvested": I64,
        "totalCrystalsRefined": I64,
        "terraformingHabitat": PublicKey,
        "active": true,
        "durability": 987,
        "habitatsTerraformed": 987,
        "sequence": I64,
        "guild": 123,
        "subHabitatCooldownTimestamp": DateTimeUtc,
        "harvesterSettingsCooldownTimestamp": DateTimeUtc,
        "dailyKiHarvestingCap": U64,
        "kiAvailableToHarvest": U64,
        "hasMaxKi": false,
        "rentalAgreement": GenoRentalAgreement,
        "parentHabitatData": GenoHabitat,
        "subHabitatData": [GenoHabitat],
        "nft": Nft
      }
    ]
  }
}

genoHabitatsCounted

Description

Query zero or more Genopets habitats

Response

Returns a GenoHabitatList!

Arguments
Name Description
params - GenoHabitatsParams!

Example

Query
query genoHabitatsCounted($params: GenoHabitatsParams!) {
  genoHabitatsCounted(params: $params) {
    habitats {
      ...GenoHabitatFragment
    }
    totalCountHint
  }
}
Variables
{"params": GenoHabitatsParams}
Response
{
  "data": {
    "genoHabitatsCounted": {
      "habitats": [GenoHabitat],
      "totalCountHint": I64
    }
  }
}

governances

Response

Returns [Governance!]!

Arguments
Name Description
addresses - [PublicKey!]
realms - [PublicKey!]

Example

Query
query governances(
  $addresses: [PublicKey!],
  $realms: [PublicKey!]
) {
  governances(
    addresses: $addresses,
    realms: $realms
  ) {
    address
    accountType
    governedAccount
    proposalsCount
    votingProposalCount
    governanceConfig {
      ...GovernanceConfigFragment
    }
    realm {
      ...RealmFragment
    }
  }
}
Variables
{
  "addresses": [PublicKey],
  "realms": [PublicKey]
}
Response
{
  "data": {
    "governances": [
      {
        "address": PublicKey,
        "accountType": "UNINITIALIZED",
        "governedAccount": PublicKey,
        "proposalsCount": I64,
        "votingProposalCount": 987,
        "governanceConfig": GovernanceConfig,
        "realm": Realm
      }
    ]
  }
}

latestFeedEvents

Description

Returns the latest on chain events using the graph_program.

Response

Returns [FeedEvent!]!

Arguments
Name Description
limit - Int! The query record limit
isForward - Boolean! Data record needed forward or backward
cursor - String! The query record offset
includeTypes - [String!]

Example

Query
query latestFeedEvents(
  $limit: Int!,
  $isForward: Boolean!,
  $cursor: String!,
  $includeTypes: [String!]
) {
  latestFeedEvents(
    limit: $limit,
    isForward: $isForward,
    cursor: $cursor,
    includeTypes: $includeTypes
  ) {
    ... on MintEvent {
      ...MintEventFragment
    }
    ... on OfferEvent {
      ...OfferEventFragment
    }
    ... on ListingEvent {
      ...ListingEventFragment
    }
    ... on PurchaseEvent {
      ...PurchaseEventFragment
    }
    ... on FollowEvent {
      ...FollowEventFragment
    }
  }
}
Variables
{
  "limit": 987,
  "isForward": true,
  "cursor": "abc123",
  "includeTypes": ["abc123"]
}
Response
{"data": {"latestFeedEvents": [MintEvent]}}

listings

Response

Returns [Listing!]!

Example

Query
query listings {
  listings {
    address
    extAddress
    cacheAddress
    storeAddress
    endsAt
    ended
    storefront {
      ...StorefrontFragment
    }
    nfts {
      ...NftFragment
    }
    bids {
      ...BidFragment
    }
  }
}
Response
{
  "data": {
    "listings": [
      {
        "address": "abc123",
        "extAddress": "abc123",
        "cacheAddress": "abc123",
        "storeAddress": "xyz789",
        "endsAt": DateTimeUtc,
        "ended": false,
        "storefront": Storefront,
        "nfts": [Nft],
        "bids": [Bid]
      }
    ]
  }
}

marketplace

Description

A marketplace

Response

Returns a Marketplace

Arguments
Name Description
subdomain - String!

Example

Query
query marketplace($subdomain: String!) {
  marketplace(subdomain: $subdomain) {
    configAddress
    subdomain
    name
    description
    logoUrl
    bannerUrl
    ownerAddress
    storeAddress
    auctionHouses {
      ...AuctionHouseFragment
    }
    creators {
      ...StoreCreatorFragment
    }
    stats {
      ...MarketStatsFragment
    }
  }
}
Variables
{"subdomain": "abc123"}
Response
{
  "data": {
    "marketplace": {
      "configAddress": PublicKey,
      "subdomain": "abc123",
      "name": "abc123",
      "description": "xyz789",
      "logoUrl": "xyz789",
      "bannerUrl": "xyz789",
      "ownerAddress": "xyz789",
      "storeAddress": PublicKey,
      "auctionHouses": [AuctionHouse],
      "creators": [StoreCreator],
      "stats": MarketStats
    }
  }
}

marketplaces

Description

Get multiple marketplaces; results will be in alphabetical order by subdomain

Response

Returns [Marketplace!]!

Arguments
Name Description
subdomains - [String!]
limit - Int
offset - Int

Example

Query
query marketplaces(
  $subdomains: [String!],
  $limit: Int,
  $offset: Int
) {
  marketplaces(
    subdomains: $subdomains,
    limit: $limit,
    offset: $offset
  ) {
    configAddress
    subdomain
    name
    description
    logoUrl
    bannerUrl
    ownerAddress
    storeAddress
    auctionHouses {
      ...AuctionHouseFragment
    }
    creators {
      ...StoreCreatorFragment
    }
    stats {
      ...MarketStatsFragment
    }
  }
}
Variables
{
  "subdomains": ["xyz789"],
  "limit": 987,
  "offset": 123
}
Response
{
  "data": {
    "marketplaces": [
      {
        "configAddress": PublicKey,
        "subdomain": "abc123",
        "name": "xyz789",
        "description": "xyz789",
        "logoUrl": "abc123",
        "bannerUrl": "abc123",
        "ownerAddress": "abc123",
        "storeAddress": PublicKey,
        "auctionHouses": [AuctionHouse],
        "creators": [StoreCreator],
        "stats": MarketStats
      }
    ]
  }
}

metadataJsons

Description

returns metadata_jsons matching the term

Response

Returns [MetadataJson!]!

Arguments
Name Description
term - String!
limit - Int!
offset - Int!

Example

Query
query metadataJsons(
  $term: String!,
  $limit: Int!,
  $offset: Int!
) {
  metadataJsons(
    term: $term,
    limit: $limit,
    offset: $offset
  ) {
    address
    name
    mintAddress
    image
    creatorAddress
    creatorTwitterHandle
  }
}
Variables
{
  "term": "abc123",
  "limit": 987,
  "offset": 987
}
Response
{
  "data": {
    "metadataJsons": [
      {
        "address": "xyz789",
        "name": "abc123",
        "mintAddress": "abc123",
        "image": "abc123",
        "creatorAddress": "xyz789",
        "creatorTwitterHandle": "xyz789"
      }
    ]
  }
}

nft

Description

Get an NFT by metadata address.

Response

Returns a Nft

Arguments
Name Description
address - String!

Example

Query
query nft($address: String!) {
  nft(address: $address) {
    address
    name
    sellerFeeBasisPoints
    mintAddress
    tokenAccountAddress
    primarySaleHappened
    updateAuthorityAddress
    description
    category
    parser
    image
    imageOriginal
    animationUrl
    externalUrl
    creators {
      ...NftCreatorFragment
    }
    attributes {
      ...NftAttributeFragment
    }
    owner {
      ...NftOwnerFragment
    }
    activities {
      ...NftActivityFragment
    }
    listings {
      ...AhListingFragment
    }
    purchases {
      ...PurchaseFragment
    }
    offers {
      ...OfferFragment
    }
    files {
      ...NftFileFragment
    }
    collection {
      ...CollectionNFTFragment
    }
    moonrankCollection {
      ...CollectionFragment
    }
    createdAt
    moonrankRank
    lastSale {
      ...LastSaleFragment
    }
  }
}
Variables
{"address": "xyz789"}
Response
{
  "data": {
    "nft": {
      "address": "xyz789",
      "name": "xyz789",
      "sellerFeeBasisPoints": 987,
      "mintAddress": "abc123",
      "tokenAccountAddress": "abc123",
      "primarySaleHappened": false,
      "updateAuthorityAddress": "abc123",
      "description": "abc123",
      "category": "xyz789",
      "parser": "abc123",
      "image": "abc123",
      "imageOriginal": "xyz789",
      "animationUrl": "abc123",
      "externalUrl": "abc123",
      "creators": [NftCreator],
      "attributes": [NftAttribute],
      "owner": NftOwner,
      "activities": [NftActivity],
      "listings": [AhListing],
      "purchases": [Purchase],
      "offers": [Offer],
      "files": [NftFile],
      "collection": CollectionNFT,
      "moonrankCollection": Collection,
      "createdAt": DateTimeUtc,
      "moonrankRank": I64,
      "lastSale": LastSale
    }
  }
}

nftByMintAddress

Description

Get an NFT by mint address.

Response

Returns a Nft

Arguments
Name Description
address - String!

Example

Query
query nftByMintAddress($address: String!) {
  nftByMintAddress(address: $address) {
    address
    name
    sellerFeeBasisPoints
    mintAddress
    tokenAccountAddress
    primarySaleHappened
    updateAuthorityAddress
    description
    category
    parser
    image
    imageOriginal
    animationUrl
    externalUrl
    creators {
      ...NftCreatorFragment
    }
    attributes {
      ...NftAttributeFragment
    }
    owner {
      ...NftOwnerFragment
    }
    activities {
      ...NftActivityFragment
    }
    listings {
      ...AhListingFragment
    }
    purchases {
      ...PurchaseFragment
    }
    offers {
      ...OfferFragment
    }
    files {
      ...NftFileFragment
    }
    collection {
      ...CollectionNFTFragment
    }
    moonrankCollection {
      ...CollectionFragment
    }
    createdAt
    moonrankRank
    lastSale {
      ...LastSaleFragment
    }
  }
}
Variables
{"address": "xyz789"}
Response
{
  "data": {
    "nftByMintAddress": {
      "address": "xyz789",
      "name": "xyz789",
      "sellerFeeBasisPoints": 123,
      "mintAddress": "abc123",
      "tokenAccountAddress": "xyz789",
      "primarySaleHappened": true,
      "updateAuthorityAddress": "xyz789",
      "description": "abc123",
      "category": "xyz789",
      "parser": "xyz789",
      "image": "abc123",
      "imageOriginal": "abc123",
      "animationUrl": "xyz789",
      "externalUrl": "abc123",
      "creators": [NftCreator],
      "attributes": [NftAttribute],
      "owner": NftOwner,
      "activities": [NftActivity],
      "listings": [AhListing],
      "purchases": [Purchase],
      "offers": [Offer],
      "files": [NftFile],
      "collection": CollectionNFT,
      "moonrankCollection": Collection,
      "createdAt": DateTimeUtc,
      "moonrankRank": I64,
      "lastSale": LastSale
    }
  }
}

nftCounts

Response

Returns a NftCount!

Arguments
Name Description
creators - [PublicKey!]! creators of nfts

Example

Query
query nftCounts($creators: [PublicKey!]!) {
  nftCounts(creators: $creators) {
    total
    listed
  }
}
Variables
{"creators": [PublicKey]}
Response
{"data": {"nftCounts": {"total": 123, "listed": 987}}}

nfts

Response

Returns [Nft!]!

Arguments
Name Description
owners - [PublicKey!]
creators - [PublicKey!]
updateAuthorities - [PublicKey!]
offerers - [PublicKey!]
attributes - [AttributeFilter!]
listed - Boolean
allowUnverified - Boolean
withOffers - Boolean
auctionHouses - [PublicKey!]
collection - PublicKey
collections - [PublicKey!]
term - String
limit - Int!
offset - Int!

Example

Query
query nfts(
  $owners: [PublicKey!],
  $creators: [PublicKey!],
  $updateAuthorities: [PublicKey!],
  $offerers: [PublicKey!],
  $attributes: [AttributeFilter!],
  $listed: Boolean,
  $allowUnverified: Boolean,
  $withOffers: Boolean,
  $auctionHouses: [PublicKey!],
  $collection: PublicKey,
  $collections: [PublicKey!],
  $term: String,
  $limit: Int!,
  $offset: Int!
) {
  nfts(
    owners: $owners,
    creators: $creators,
    updateAuthorities: $updateAuthorities,
    offerers: $offerers,
    attributes: $attributes,
    listed: $listed,
    allowUnverified: $allowUnverified,
    withOffers: $withOffers,
    auctionHouses: $auctionHouses,
    collection: $collection,
    collections: $collections,
    term: $term,
    limit: $limit,
    offset: $offset
  ) {
    address
    name
    sellerFeeBasisPoints
    mintAddress
    tokenAccountAddress
    primarySaleHappened
    updateAuthorityAddress
    description
    category
    parser
    image
    imageOriginal
    animationUrl
    externalUrl
    creators {
      ...NftCreatorFragment
    }
    attributes {
      ...NftAttributeFragment
    }
    owner {
      ...NftOwnerFragment
    }
    activities {
      ...NftActivityFragment
    }
    listings {
      ...AhListingFragment
    }
    purchases {
      ...PurchaseFragment
    }
    offers {
      ...OfferFragment
    }
    files {
      ...NftFileFragment
    }
    collection {
      ...CollectionNFTFragment
    }
    moonrankCollection {
      ...CollectionFragment
    }
    createdAt
    moonrankRank
    lastSale {
      ...LastSaleFragment
    }
  }
}
Variables
{
  "owners": [PublicKey],
  "creators": [PublicKey],
  "updateAuthorities": [PublicKey],
  "offerers": [PublicKey],
  "attributes": [AttributeFilter],
  "listed": false,
  "allowUnverified": false,
  "withOffers": false,
  "auctionHouses": [PublicKey],
  "collection": PublicKey,
  "collections": [PublicKey],
  "term": "xyz789",
  "limit": 987,
  "offset": 987
}
Response
{
  "data": {
    "nfts": [
      {
        "address": "xyz789",
        "name": "xyz789",
        "sellerFeeBasisPoints": 123,
        "mintAddress": "xyz789",
        "tokenAccountAddress": "abc123",
        "primarySaleHappened": true,
        "updateAuthorityAddress": "abc123",
        "description": "abc123",
        "category": "abc123",
        "parser": "abc123",
        "image": "xyz789",
        "imageOriginal": "abc123",
        "animationUrl": "xyz789",
        "externalUrl": "xyz789",
        "creators": [NftCreator],
        "attributes": [NftAttribute],
        "owner": NftOwner,
        "activities": [NftActivity],
        "listings": [AhListing],
        "purchases": [Purchase],
        "offers": [Offer],
        "files": [NftFile],
        "collection": CollectionNFT,
        "moonrankCollection": Collection,
        "createdAt": DateTimeUtc,
        "moonrankRank": I64,
        "lastSale": LastSale
      }
    ]
  }
}

nftsByMintAddress

Description

Get a list of NFTs by mint address.

Response

Returns [Nft!]!

Arguments
Name Description
addresses - [PublicKey!]!

Example

Query
query nftsByMintAddress($addresses: [PublicKey!]!) {
  nftsByMintAddress(addresses: $addresses) {
    address
    name
    sellerFeeBasisPoints
    mintAddress
    tokenAccountAddress
    primarySaleHappened
    updateAuthorityAddress
    description
    category
    parser
    image
    imageOriginal
    animationUrl
    externalUrl
    creators {
      ...NftCreatorFragment
    }
    attributes {
      ...NftAttributeFragment
    }
    owner {
      ...NftOwnerFragment
    }
    activities {
      ...NftActivityFragment
    }
    listings {
      ...AhListingFragment
    }
    purchases {
      ...PurchaseFragment
    }
    offers {
      ...OfferFragment
    }
    files {
      ...NftFileFragment
    }
    collection {
      ...CollectionNFTFragment
    }
    moonrankCollection {
      ...CollectionFragment
    }
    createdAt
    moonrankRank
    lastSale {
      ...LastSaleFragment
    }
  }
}
Variables
{"addresses": [PublicKey]}
Response
{
  "data": {
    "nftsByMintAddress": [
      {
        "address": "xyz789",
        "name": "xyz789",
        "sellerFeeBasisPoints": 987,
        "mintAddress": "xyz789",
        "tokenAccountAddress": "xyz789",
        "primarySaleHappened": true,
        "updateAuthorityAddress": "xyz789",
        "description": "xyz789",
        "category": "abc123",
        "parser": "xyz789",
        "image": "abc123",
        "imageOriginal": "xyz789",
        "animationUrl": "xyz789",
        "externalUrl": "xyz789",
        "creators": [NftCreator],
        "attributes": [NftAttribute],
        "owner": NftOwner,
        "activities": [NftActivity],
        "listings": [AhListing],
        "purchases": [Purchase],
        "offers": [Offer],
        "files": [NftFile],
        "collection": CollectionNFT,
        "moonrankCollection": Collection,
        "createdAt": DateTimeUtc,
        "moonrankRank": I64,
        "lastSale": LastSale
      }
    ]
  }
}

nftsStats

Description

Stats aggregated across all indexed NFTs

Response

Returns a NftsStats!

Example

Query
query nftsStats {
  nftsStats {
    totalNfts
    buyNowListings
    nftsWithActiveOffers
  }
}
Response
{
  "data": {
    "nftsStats": {
      "totalNfts": 123,
      "buyNowListings": 123,
      "nftsWithActiveOffers": 987
    }
  }
}

offer

Response

Returns a BidReceipt

Arguments
Name Description
address - String!

Example

Query
query offer($address: String!) {
  offer(address: $address) {
    address
    tradeState
    buyer
    metadata
    price
    tradeStateBump
    tokenAccount
    createdAt
    canceledAt
    bookkeeper
    purchaseReceipt
    tokenSize
    bump
    nft {
      ...NftFragment
    }
    auctionHouse {
      ...AuctionHouseFragment
    }
  }
}
Variables
{"address": "abc123"}
Response
{
  "data": {
    "offer": {
      "address": "xyz789",
      "tradeState": "xyz789",
      "buyer": PublicKey,
      "metadata": PublicKey,
      "price": U64,
      "tradeStateBump": 987,
      "tokenAccount": "abc123",
      "createdAt": DateTimeUtc,
      "canceledAt": DateTimeUtc,
      "bookkeeper": PublicKey,
      "purchaseReceipt": PublicKey,
      "tokenSize": 123,
      "bump": 987,
      "nft": Nft,
      "auctionHouse": AuctionHouse
    }
  }
}

profile

Response

Returns a TwitterProfile

Arguments
Name Description
handle - String!

Example

Query
query profile($handle: String!) {
  profile(handle: $handle) {
    walletAddress
    handle
    profileImageUrl
    profileImageUrlLowres
    profileImageUrlHighres
    bannerImageUrl
    description
  }
}
Variables
{"handle": "xyz789"}
Response
{
  "data": {
    "profile": {
      "walletAddress": "xyz789",
      "handle": "xyz789",
      "profileImageUrl": "xyz789",
      "profileImageUrlLowres": "xyz789",
      "profileImageUrlHighres": "xyz789",
      "bannerImageUrl": "xyz789",
      "description": "abc123"
    }
  }
}

profiles

Description

returns profiles matching the search term

Response

Returns [Wallet!]!

Arguments
Name Description
term - String!
limit - Int!
offset - Int!

Example

Query
query profiles(
  $term: String!,
  $limit: Int!,
  $offset: Int!
) {
  profiles(
    term: $term,
    limit: $limit,
    offset: $offset
  ) {
    address
    twitterHandle
    nfts {
      ...NftFragment
    }
    associatedTokenAccounts {
      ...AssociatedTokenAccountFragment
    }
    collectedCollections {
      ...CollectedCollectionFragment
    }
    activities {
      ...WalletActivityFragment
    }
    offers {
      ...OfferFragment
    }
    bids {
      ...BidFragment
    }
    profile {
      ...TwitterProfileFragment
    }
    connectionCounts {
      ...ConnectionCountsFragment
    }
    nftCounts {
      ...WalletNftCountFragment
    }
    totalRewards
  }
}
Variables
{
  "term": "abc123",
  "limit": 987,
  "offset": 987
}
Response
{
  "data": {
    "profiles": [
      {
        "address": PublicKey,
        "twitterHandle": "xyz789",
        "nfts": [Nft],
        "associatedTokenAccounts": [
          AssociatedTokenAccount
        ],
        "collectedCollections": [CollectedCollection],
        "activities": [WalletActivity],
        "offers": [Offer],
        "bids": [Bid],
        "profile": TwitterProfile,
        "connectionCounts": ConnectionCounts,
        "nftCounts": WalletNftCount,
        "totalRewards": U64
      }
    ]
  }
}

profilesStats

Description

returns stats about profiles

Response

Returns a ProfilesStats!

Example

Query
query profilesStats {
  profilesStats {
    totalProfiles
  }
}
Response
{"data": {"profilesStats": {"totalProfiles": 987}}}

proposals

Response

Returns [Proposal!]!

Arguments
Name Description
addresses - [PublicKey!]
governances - [PublicKey!]
startTimestamp - DateTimeUtc
endTimestamp - DateTimeUtc
limit - Int
offset - Int

Example

Query
query proposals(
  $addresses: [PublicKey!],
  $governances: [PublicKey!],
  $startTimestamp: DateTimeUtc,
  $endTimestamp: DateTimeUtc,
  $limit: Int,
  $offset: Int
) {
  proposals(
    addresses: $addresses,
    governances: $governances,
    startTimestamp: $startTimestamp,
    endTimestamp: $endTimestamp,
    limit: $limit,
    offset: $offset
  ) {
    ... on ProposalV1 {
      ...ProposalV1Fragment
    }
    ... on ProposalV2 {
      ...ProposalV2Fragment
    }
  }
}
Variables
{
  "addresses": [PublicKey],
  "governances": [PublicKey],
  "startTimestamp": DateTimeUtc,
  "endTimestamp": DateTimeUtc,
  "limit": 987,
  "offset": 123
}
Response
{"data": {"proposals": [ProposalV1]}}

realms

Response

Returns [Realm!]!

Arguments
Name Description
addresses - [PublicKey!]
communityMints - [PublicKey!]
limit - Int
offset - Int

Example

Query
query realms(
  $addresses: [PublicKey!],
  $communityMints: [PublicKey!],
  $limit: Int,
  $offset: Int
) {
  realms(
    addresses: $addresses,
    communityMints: $communityMints,
    limit: $limit,
    offset: $offset
  ) {
    address
    accountType
    communityMint
    votingProposalCount
    authority
    name
    programId
    realmConfig {
      ...RealmConfigFragment
    }
  }
}
Variables
{
  "addresses": [PublicKey],
  "communityMints": [PublicKey],
  "limit": 123,
  "offset": 987
}
Response
{
  "data": {
    "realms": [
      {
        "address": PublicKey,
        "accountType": "UNINITIALIZED",
        "communityMint": PublicKey,
        "votingProposalCount": 987,
        "authority": PublicKey,
        "name": "xyz789",
        "programId": PublicKey,
        "realmConfig": RealmConfig
      }
    ]
  }
}

searchCollections

Description

returns all the collections matching the search term

Response

Returns [CollectionDocument!]!

Arguments
Name Description
term - String!
limit - Int!
offset - Int!

Example

Query
query searchCollections(
  $term: String!,
  $limit: Int!,
  $offset: Int!
) {
  searchCollections(
    term: $term,
    limit: $limit,
    offset: $offset
  ) {
    id
    name
    image
    magicEdenId
    verifiedCollectionAddress
    twitterUrl
    discordUrl
    websiteUrl
  }
}
Variables
{
  "term": "xyz789",
  "limit": 987,
  "offset": 987
}
Response
{
  "data": {
    "searchCollections": [
      {
        "id": "abc123",
        "name": "abc123",
        "image": "abc123",
        "magicEdenId": "abc123",
        "verifiedCollectionAddress": "xyz789",
        "twitterUrl": "abc123",
        "discordUrl": "xyz789",
        "websiteUrl": "xyz789"
      }
    ]
  }
}

signatoryRecords

Response

Returns [SignatoryRecord!]!

Arguments
Name Description
addresses - [PublicKey!]
proposals - [PublicKey!]

Example

Query
query signatoryRecords(
  $addresses: [PublicKey!],
  $proposals: [PublicKey!]
) {
  signatoryRecords(
    addresses: $addresses,
    proposals: $proposals
  ) {
    address
    accountType
    signatory
    signedOff
    proposal {
      ... on ProposalV1 {
        ...ProposalV1Fragment
      }
      ... on ProposalV2 {
        ...ProposalV2Fragment
      }
    }
  }
}
Variables
{
  "addresses": [PublicKey],
  "proposals": [PublicKey]
}
Response
{
  "data": {
    "signatoryRecords": [
      {
        "address": PublicKey,
        "accountType": "UNINITIALIZED",
        "signatory": PublicKey,
        "signedOff": true,
        "proposal": ProposalV1
      }
    ]
  }
}

solanaNetwork

Response

Returns a SolanaNetwork!

Example

Query
query solanaNetwork {
  solanaNetwork {
    tps
    price
  }
}
Response
{"data": {"solanaNetwork": {"tps": 987, "price": 987.65}}}

storefront

Description

A storefront

Response

Returns a Storefront

Arguments
Name Description
subdomain - String!

Example

Query
query storefront($subdomain: String!) {
  storefront(subdomain: $subdomain) {
    address
    ownerAddress
    subdomain
    title
    description
    faviconUrl
    logoUrl
    bannerUrl
  }
}
Variables
{"subdomain": "abc123"}
Response
{
  "data": {
    "storefront": {
      "address": "abc123",
      "ownerAddress": "abc123",
      "subdomain": "abc123",
      "title": "xyz789",
      "description": "xyz789",
      "faviconUrl": "xyz789",
      "logoUrl": "xyz789",
      "bannerUrl": "abc123"
    }
  }
}

storefronts

Response

Returns [Storefront!]!

Example

Query
query storefronts {
  storefronts {
    address
    ownerAddress
    subdomain
    title
    description
    faviconUrl
    logoUrl
    bannerUrl
  }
}
Response
{
  "data": {
    "storefronts": [
      {
        "address": "abc123",
        "ownerAddress": "xyz789",
        "subdomain": "abc123",
        "title": "xyz789",
        "description": "xyz789",
        "faviconUrl": "xyz789",
        "logoUrl": "xyz789",
        "bannerUrl": "xyz789"
      }
    ]
  }
}

tokenOwnerRecords

Response

Returns [TokenOwnerRecord!]!

Arguments
Name Description
addresses - [PublicKey!]
realms - [PublicKey!]
governingTokenMints - [PublicKey!]

Example

Query
query tokenOwnerRecords(
  $addresses: [PublicKey!],
  $realms: [PublicKey!],
  $governingTokenMints: [PublicKey!]
) {
  tokenOwnerRecords(
    addresses: $addresses,
    realms: $realms,
    governingTokenMints: $governingTokenMints
  ) {
    address
    accountType
    governingTokenMint
    governingTokenOwner
    governingTokenDepositAmount
    unrelinquishedVotesCount
    totalVotesCount
    outstandingProposalCount
    governanceDelegate
    realm {
      ...RealmFragment
    }
  }
}
Variables
{
  "addresses": [PublicKey],
  "realms": [PublicKey],
  "governingTokenMints": [PublicKey]
}
Response
{
  "data": {
    "tokenOwnerRecords": [
      {
        "address": PublicKey,
        "accountType": "UNINITIALIZED",
        "governingTokenMint": PublicKey,
        "governingTokenOwner": PublicKey,
        "governingTokenDepositAmount": I64,
        "unrelinquishedVotesCount": I64,
        "totalVotesCount": I64,
        "outstandingProposalCount": 123,
        "governanceDelegate": PublicKey,
        "realm": Realm
      }
    ]
  }
}

voteRecords

Response

Returns [VoteRecord!]!

Arguments
Name Description
addresses - [PublicKey!]
proposals - [PublicKey!]
governingTokenOwners - [PublicKey!]
isRelinquished - Boolean

Example

Query
query voteRecords(
  $addresses: [PublicKey!],
  $proposals: [PublicKey!],
  $governingTokenOwners: [PublicKey!],
  $isRelinquished: Boolean
) {
  voteRecords(
    addresses: $addresses,
    proposals: $proposals,
    governingTokenOwners: $governingTokenOwners,
    isRelinquished: $isRelinquished
  ) {
    ... on VoteRecordV1 {
      ...VoteRecordV1Fragment
    }
    ... on VoteRecordV2 {
      ...VoteRecordV2Fragment
    }
  }
}
Variables
{
  "addresses": [PublicKey],
  "proposals": [PublicKey],
  "governingTokenOwners": [PublicKey],
  "isRelinquished": false
}
Response
{"data": {"voteRecords": [VoteRecordV1]}}

wallet

Response

Returns a Wallet!

Arguments
Name Description
address - PublicKey!

Example

Query
query wallet($address: PublicKey!) {
  wallet(address: $address) {
    address
    twitterHandle
    nfts {
      ...NftFragment
    }
    associatedTokenAccounts {
      ...AssociatedTokenAccountFragment
    }
    collectedCollections {
      ...CollectedCollectionFragment
    }
    activities {
      ...WalletActivityFragment
    }
    offers {
      ...OfferFragment
    }
    bids {
      ...BidFragment
    }
    profile {
      ...TwitterProfileFragment
    }
    connectionCounts {
      ...ConnectionCountsFragment
    }
    nftCounts {
      ...WalletNftCountFragment
    }
    totalRewards
  }
}
Variables
{"address": PublicKey}
Response
{
  "data": {
    "wallet": {
      "address": PublicKey,
      "twitterHandle": "abc123",
      "nfts": [Nft],
      "associatedTokenAccounts": [AssociatedTokenAccount],
      "collectedCollections": [CollectedCollection],
      "activities": [WalletActivity],
      "offers": [Offer],
      "bids": [Bid],
      "profile": TwitterProfile,
      "connectionCounts": ConnectionCounts,
      "nftCounts": WalletNftCount,
      "totalRewards": U64
    }
  }
}

wallets

Response

Returns [Wallet!]!

Arguments
Name Description
addresses - [PublicKey!]!

Example

Query
query wallets($addresses: [PublicKey!]!) {
  wallets(addresses: $addresses) {
    address
    twitterHandle
    nfts {
      ...NftFragment
    }
    associatedTokenAccounts {
      ...AssociatedTokenAccountFragment
    }
    collectedCollections {
      ...CollectedCollectionFragment
    }
    activities {
      ...WalletActivityFragment
    }
    offers {
      ...OfferFragment
    }
    bids {
      ...BidFragment
    }
    profile {
      ...TwitterProfileFragment
    }
    connectionCounts {
      ...ConnectionCountsFragment
    }
    nftCounts {
      ...WalletNftCountFragment
    }
    totalRewards
  }
}
Variables
{"addresses": [PublicKey]}
Response
{
  "data": {
    "wallets": [
      {
        "address": PublicKey,
        "twitterHandle": "xyz789",
        "nfts": [Nft],
        "associatedTokenAccounts": [
          AssociatedTokenAccount
        ],
        "collectedCollections": [CollectedCollection],
        "activities": [WalletActivity],
        "offers": [Offer],
        "bids": [Bid],
        "profile": TwitterProfile,
        "connectionCounts": ConnectionCounts,
        "nftCounts": WalletNftCount,
        "totalRewards": U64
      }
    ]
  }
}

Types

AhListing

Fields
Field Name Description
id - Uuid!
tradeState - String!
seller - PublicKey!
metadata - PublicKey!
purchaseId - Uuid
price - U64!
tokenSize - Int!
tradeStateBump - Int!
createdAt - DateTimeUtc!
canceledAt - DateTimeUtc
marketplaceProgramAddress - String!
nft - Nft
auctionHouse - AuctionHouse
Example
{
  "id": Uuid,
  "tradeState": "abc123",
  "seller": PublicKey,
  "metadata": PublicKey,
  "purchaseId": Uuid,
  "price": U64,
  "tokenSize": 123,
  "tradeStateBump": 987,
  "createdAt": DateTimeUtc,
  "canceledAt": DateTimeUtc,
  "marketplaceProgramAddress": "abc123",
  "nft": Nft,
  "auctionHouse": AuctionHouse
}

AssociatedTokenAccount

Fields
Field Name Description
address - PublicKey!
mint - PublicKey!
owner - PublicKey!
amount - U64!
Example
{
  "address": PublicKey,
  "mint": PublicKey,
  "owner": PublicKey,
  "amount": U64
}

AttributeFilter

Description

Filter on NFT attributes

Fields
Input Field Description
traitType - String!
values - [String!]!
Example
{
  "traitType": "xyz789",
  "values": ["abc123"]
}

AttributeGroup

Fields
Field Name Description
name - String!
variants - [AttributeVariant!]!
Example
{
  "name": "xyz789",
  "variants": [AttributeVariant]
}

AttributeVariant

Fields
Field Name Description
name - String!
count - Int!
Example
{"name": "abc123", "count": 123}

AuctionHouse

Fields
Field Name Description
stats - MintStats
address - PublicKey!
treasuryMint - String!
auctionHouseTreasury - String!
treasuryWithdrawalDestination - String!
feeWithdrawalDestination - String!
authority - String!
creator - String!
bump - Int!
treasuryBump - Int!
feePayerBump - Int!
sellerFeeBasisPoints - Int!
requiresSignOff - Boolean!
canChangeSalePrice - Boolean!
auctionHouseFeeAccount - String!
rewardCenter - RewardCenter
Example
{
  "stats": MintStats,
  "address": PublicKey,
  "treasuryMint": "xyz789",
  "auctionHouseTreasury": "xyz789",
  "treasuryWithdrawalDestination": "xyz789",
  "feeWithdrawalDestination": "xyz789",
  "authority": "xyz789",
  "creator": "xyz789",
  "bump": 987,
  "treasuryBump": 987,
  "feePayerBump": 987,
  "sellerFeeBasisPoints": 123,
  "requiresSignOff": false,
  "canChangeSalePrice": false,
  "auctionHouseFeeAccount": "xyz789",
  "rewardCenter": RewardCenter
}

Bid

Fields
Field Name Description
listingAddress - String!
bidderAddress - String!
lastBidTime - String!
lastBidAmount - U64!
cancelled - Boolean!
listing - Listing
Example
{
  "listingAddress": "abc123",
  "bidderAddress": "abc123",
  "lastBidTime": "xyz789",
  "lastBidAmount": U64,
  "cancelled": false,
  "listing": Listing
}

BidReceipt

Fields
Field Name Description
address - String!
tradeState - String!
buyer - PublicKey!
metadata - PublicKey!
price - U64!
tradeStateBump - Int!
tokenAccount - String
createdAt - DateTimeUtc!
canceledAt - DateTimeUtc
bookkeeper - PublicKey!
purchaseReceipt - PublicKey
tokenSize - Int!
bump - Int!
nft - Nft
auctionHouse - AuctionHouse
Example
{
  "address": "abc123",
  "tradeState": "abc123",
  "buyer": PublicKey,
  "metadata": PublicKey,
  "price": U64,
  "tradeStateBump": 987,
  "tokenAccount": "xyz789",
  "createdAt": DateTimeUtc,
  "canceledAt": DateTimeUtc,
  "bookkeeper": PublicKey,
  "purchaseReceipt": PublicKey,
  "tokenSize": 987,
  "bump": 123,
  "nft": Nft,
  "auctionHouse": AuctionHouse
}

Boolean

CandyMachine

Fields
Field Name Description
address - PublicKey!
authority - PublicKey!
wallet - PublicKey!
tokenMint - PublicKey
itemsRedeemed - U64!
uuid - String!
price - U64!
symbol - String!
sellerFeeBasisPoints - Int!
maxSupply - U64!
isMutable - Boolean!
retainAuthority - Boolean!
goLiveDate - U64
itemsAvailable - U64!
creators - [CandyMachineCreator!]! NOTE - this is currently bugged and will only return one creator
collectionPda - CandyMachineCollectionPda
configLines - [CandyMachineConfigLine!]! NOTE - this is currently bugged and will always be empty
endSetting - CandyMachineEndSetting
whitelistMintSetting - CandyMachineWhitelistMintSetting
hiddenSetting - CandyMachineHiddenSetting
gateKeeperConfig - CandyMachineGateKeeperConfig
Example
{
  "address": PublicKey,
  "authority": PublicKey,
  "wallet": PublicKey,
  "tokenMint": PublicKey,
  "itemsRedeemed": U64,
  "uuid": "xyz789",
  "price": U64,
  "symbol": "xyz789",
  "sellerFeeBasisPoints": 987,
  "maxSupply": U64,
  "isMutable": false,
  "retainAuthority": true,
  "goLiveDate": U64,
  "itemsAvailable": U64,
  "creators": [CandyMachineCreator],
  "collectionPda": CandyMachineCollectionPda,
  "configLines": [CandyMachineConfigLine],
  "endSetting": CandyMachineEndSetting,
  "whitelistMintSetting": CandyMachineWhitelistMintSetting,
  "hiddenSetting": CandyMachineHiddenSetting,
  "gateKeeperConfig": CandyMachineGateKeeperConfig
}

CandyMachineCollectionPda

Fields
Field Name Description
candyMachineAddress - PublicKey!
collectionPda - PublicKey!
mint - PublicKey!
Example
{
  "candyMachineAddress": PublicKey,
  "collectionPda": PublicKey,
  "mint": PublicKey
}

CandyMachineConfigLine

Fields
Field Name Description
candyMachineAddress - PublicKey!
name - String!
uri - String!
idx - Int!
taken - Boolean!
Example
{
  "candyMachineAddress": PublicKey,
  "name": "abc123",
  "uri": "abc123",
  "idx": 123,
  "taken": false
}

CandyMachineCreator

Fields
Field Name Description
candyMachineAddress - PublicKey!
creatorAddress - PublicKey!
verified - Boolean!
share - Int!
Example
{
  "candyMachineAddress": PublicKey,
  "creatorAddress": PublicKey,
  "verified": false,
  "share": 123
}

CandyMachineEndSetting

Fields
Field Name Description
candyMachineAddress - PublicKey!
endSettingType - CandyMachineEndSettingType!
number - U64!
Example
{
  "candyMachineAddress": PublicKey,
  "endSettingType": "DATE",
  "number": U64
}

CandyMachineEndSettingType

Values
Enum Value Description

DATE

AMOUNT

Example
"DATE"

CandyMachineGateKeeperConfig

Fields
Field Name Description
candyMachineAddress - PublicKey!
gatekeeperNetwork - String!
expireOnUse - Boolean!
Example
{
  "candyMachineAddress": PublicKey,
  "gatekeeperNetwork": "abc123",
  "expireOnUse": true
}

CandyMachineHiddenSetting

Fields
Field Name Description
candyMachineAddress - PublicKey!
name - String!
uri - String!
hash - String! lowercase base64 encoded string of the hash bytes
Example
{
  "candyMachineAddress": PublicKey,
  "name": "xyz789",
  "uri": "abc123",
  "hash": "xyz789"
}

CandyMachineWhitelistMintMode

Values
Enum Value Description

BURN_EVERY_TIME

NEVER_BURN

Example
"BURN_EVERY_TIME"

CandyMachineWhitelistMintSetting

Fields
Field Name Description
candyMachineAddress - PublicKey!
mode - CandyMachineWhitelistMintMode!
mint - PublicKey!
presale - Boolean!
discountPrice - U64
Example
{
  "candyMachineAddress": PublicKey,
  "mode": "BURN_EVERY_TIME",
  "mint": PublicKey,
  "presale": true,
  "discountPrice": U64
}

CollectedCollection

Fields
Field Name Description
collection - Collection
nftsOwned - Int!
estimatedValue - Numeric!
Example
{
  "collection": Collection,
  "nftsOwned": 987,
  "estimatedValue": Numeric
}

Collection

Fields
Field Name Description
id - String!
name - String!
description - String!
twitterUrl - String
discordUrl - String
websiteUrl - String
magicEdenId - String
verifiedCollectionAddress - String
pieces - Int!
verified - Boolean!
goLiveAt - DateTimeUtc!
createdAt - DateTimeUtc!
updatedAt - DateTimeUtc!
trends - CollectionTrend
imageOriginal - String! Get the original URL of the image as stored in the NFT's metadata
image - String!
Arguments
width - Int
nfts - [Nft!]!
Arguments
limit - Int!
offset - Int!
sortBy - NftSort
order - OrderDirection
marketplaceProgram - String
auctionHouse - String
attributes - [AttributeFilter!]
attributeGroups - [AttributeGroup!]!
holderCount - I64 Count of wallets that currently hold at least one NFT from the collection.
activities - [NftActivity!]!
Arguments
eventTypes - [String!]
limit - Int!
offset - Int!
timeseries - Timeseries!
Arguments
startTime - DateTimeUtc!
endTime - DateTimeUtc!
Example
{
  "id": "abc123",
  "name": "abc123",
  "description": "xyz789",
  "twitterUrl": "xyz789",
  "discordUrl": "abc123",
  "websiteUrl": "abc123",
  "magicEdenId": "abc123",
  "verifiedCollectionAddress": "abc123",
  "pieces": 123,
  "verified": false,
  "goLiveAt": DateTimeUtc,
  "createdAt": DateTimeUtc,
  "updatedAt": DateTimeUtc,
  "trends": CollectionTrend,
  "imageOriginal": "abc123",
  "image": "abc123",
  "nfts": [Nft],
  "attributeGroups": [AttributeGroup],
  "holderCount": I64,
  "activities": [NftActivity],
  "timeseries": Timeseries
}

CollectionDocument

Fields
Field Name Description
id - String!
name - String!
image - String!
magicEdenId - String
verifiedCollectionAddress - String
twitterUrl - String
discordUrl - String
websiteUrl - String
Example
{
  "id": "xyz789",
  "name": "abc123",
  "image": "xyz789",
  "magicEdenId": "xyz789",
  "verifiedCollectionAddress": "abc123",
  "twitterUrl": "abc123",
  "discordUrl": "xyz789",
  "websiteUrl": "xyz789"
}

CollectionInterval

Description

Collection intervals

Values
Enum Value Description

ONE_DAY

SEVEN_DAY

THIRTY_DAY

Example
"ONE_DAY"

CollectionNFT

Fields
Field Name Description
nft - Nft!
nfts - [Nft!]!
Arguments
limit - Int!
offset - Int!
sortBy - NftSort
order - OrderDirection
marketplaceProgram - String
auctionHouse - String
attributes - [AttributeFilter!]
activities - [NftActivity!]!
Arguments
eventTypes - [String!]
limit - Int!
offset - Int!
floorPrice - I64 Lowest price of currently listed NFTs in the collection.
holderCount - I64 Count of wallets that currently hold at least one NFT from the collection.
listedCount - U64! Count of active listings of NFTs in the collection.
nftCount - I64 Count of NFTs in the collection.
volumeTotal - U64 Total of all sales of all NFTs in the collection over all time, in lamports.
address - String! use nft { address }
name - String! use nft { name }
sellerFeeBasisPoints - Int! use nft { seller_fee_basis_points }
mintAddress - String! use nft { mint_address }
tokenAccountAddress - String! use nft { token_account_address }
primarySaleHappened - Boolean! use nft { primary_sale_happened }
updateAuthorityAddress - String! use nft { update_authority_address }
description - String! use nft { description }
category - String! use nft { category }
parser - String use nft { parser }
image - String! use nft { image }
Arguments
width - Int
animationUrl - String use nft { animation_url }
externalUrl - String use nft { external_url }
creators - [NftCreator!]! use nft { creators }
attributes - [NftAttribute!]! use nft { attributes }
owner - NftOwner use nft { owner }
listings - [AhListing!]! use nft { ah_listings_loader }
purchases - [Purchase!]! use nft { purchases }
offers - [Offer!]! use nft { offers }
files - [NftFile!]! use nft { files }
createdAt - DateTimeUtc use nft { created_at }
Example
{
  "nft": Nft,
  "nfts": [Nft],
  "activities": [NftActivity],
  "floorPrice": I64,
  "holderCount": I64,
  "listedCount": U64,
  "nftCount": I64,
  "volumeTotal": U64,
  "address": "xyz789",
  "name": "abc123",
  "sellerFeeBasisPoints": 987,
  "mintAddress": "abc123",
  "tokenAccountAddress": "xyz789",
  "primarySaleHappened": false,
  "updateAuthorityAddress": "abc123",
  "description": "abc123",
  "category": "abc123",
  "parser": "abc123",
  "image": "xyz789",
  "animationUrl": "xyz789",
  "externalUrl": "abc123",
  "creators": [NftCreator],
  "attributes": [NftAttribute],
  "owner": NftOwner,
  "listings": [AhListing],
  "purchases": [Purchase],
  "offers": [Offer],
  "files": [NftFile],
  "createdAt": DateTimeUtc
}

CollectionSort

Description

Sorts collection results

Values
Enum Value Description

VOLUME

FLOOR

NUMBER_LISTED

Example
"VOLUME"

CollectionTrend

Fields
Field Name Description
floor1d - Numeric!
floor7d - Numeric!
floor30d - Numeric!
volume1d - Numeric!
volume7d - Numeric!
volume30d - Numeric!
listed1d - I64!
listed7d - I64!
listed30d - I64!
lastListed1d - I64!
lastListed7d - I64!
lastListed30d - I64!
lastVolume1d - Numeric!
lastVolume7d - Numeric!
lastVolume30d - Numeric!
lastFloor1d - Numeric!
lastFloor7d - Numeric!
lastFloor30d - Numeric!
changeFloor1d - Int
changeFloor7d - Int
changeFloor30d - Int
changeVolume1d - Int
changeVolume7d - Int
changeVolume30d - Int
changeListed1d - Int
changeListed7d - Int
changeListed30d - Int
collection - Collection
Example
{
  "floor1d": Numeric,
  "floor7d": Numeric,
  "floor30d": Numeric,
  "volume1d": Numeric,
  "volume7d": Numeric,
  "volume30d": Numeric,
  "listed1d": I64,
  "listed7d": I64,
  "listed30d": I64,
  "lastListed1d": I64,
  "lastListed7d": I64,
  "lastListed30d": I64,
  "lastVolume1d": Numeric,
  "lastVolume7d": Numeric,
  "lastVolume30d": Numeric,
  "lastFloor1d": Numeric,
  "lastFloor7d": Numeric,
  "lastFloor30d": Numeric,
  "changeFloor1d": 987,
  "changeFloor7d": 987,
  "changeFloor30d": 987,
  "changeVolume1d": 123,
  "changeVolume7d": 987,
  "changeVolume30d": 123,
  "changeListed1d": 987,
  "changeListed7d": 987,
  "changeListed30d": 123,
  "collection": Collection
}

ConnectionCounts

Fields
Field Name Description
fromCount - Int!
toCount - Int!
Example
{"fromCount": 123, "toCount": 987}

Creator

Fields
Field Name Description
address - String!
counts - CreatorCounts!
stats - [MintStats!]!
Arguments
auctionHouses - [PublicKey!]!

Auction house public keys

attributeGroups - [AttributeGroup!]!
profile - TwitterProfile
Example
{
  "address": "xyz789",
  "counts": CreatorCounts,
  "stats": [MintStats],
  "attributeGroups": [AttributeGroup],
  "profile": TwitterProfile
}

CreatorCounts

Fields
Field Name Description
creations - Int!
Example
{"creations": 987}

Currency

Values
Enum Value Description

BTC

ETH

LTC

BCH

BNB

EOS

XRP

XLM

LINK

DOT

YFI

USD

AED

ARS

AUD

BDT

BHD

BMD

BRL

CAD

CHF

CLP

CNY

CZK

DKK

EUR

GBP

HKD

HUF

IDR

ILS

INR

JPY

KRW

KWD

LKR

MMK

MXN

MYR

NGN

NOK

NZD

PHP

PKR

PLN

RUB

SAR

SEK

SGD

THB

TRY

TWD

UAH

VEF

VND

ZAR

XDR

XAG

XAU

BITS

SATS

Example
"BTC"

Datapoint

Fields
Field Name Description
timestamp - DateTimeUtc!
value - U64!
Example
{
  "timestamp": DateTimeUtc,
  "value": U64
}

DateTimeUtc

Description

DateTime

Example
DateTimeUtc

Denylist

Fields
Field Name Description
storefronts - [PublicKey!]!
listings - [PublicKey!]!
Example
{
  "storefronts": [PublicKey],
  "listings": [PublicKey]
}

EnrichedBondingChange

Description

Bonding change enriched with reserve change and supply change

Fields
Field Name Description
address - String!
slot - U64!
insertTs - NaiveDateTime!
reserveChange - I64!
supplyChange - I64!
Example
{
  "address": "xyz789",
  "slot": U64,
  "insertTs": NaiveDateTime,
  "reserveChange": I64,
  "supplyChange": I64
}

FeedEvent

Example
MintEvent

Float

Example
987.65

FollowEvent

Fields
Field Name Description
createdAt - DateTimeUtc!
walletAddress - PublicKey!
profile - TwitterProfile
feedEventId - String!
graphConnectionAddress - PublicKey!
connection - GraphConnection
wallet - Wallet!
Example
{
  "createdAt": DateTimeUtc,
  "walletAddress": PublicKey,
  "profile": TwitterProfile,
  "feedEventId": "xyz789",
  "graphConnectionAddress": PublicKey,
  "connection": GraphConnection,
  "wallet": Wallet
}

GenoHabitat

Fields
Field Name Description
address - PublicKey!
habitatMint - PublicKey!
level - Int!
element - Int!
genesis - Boolean!
renewalTimestamp - DateTimeUtc!
expiryTimestamp - DateTimeUtc!
nextDayTimestamp - DateTimeUtc!
crystalsRefined - Int!
harvester - String!
kiHarvested - U64!
seedsSpawned - Boolean!
isSubHabitat - Boolean!
parentHabitat - PublicKey
subHabitats - [PublicKey!]!
harvesterRoyaltyBips - Int!
harvesterOpenMarket - Boolean!
totalKiHarvested - I64!
totalCrystalsRefined - I64!
terraformingHabitat - PublicKey
active - Boolean!
durability - Int!
habitatsTerraformed - Int!
sequence - I64!
guild - Int
subHabitatCooldownTimestamp - DateTimeUtc!
harvesterSettingsCooldownTimestamp - DateTimeUtc!
dailyKiHarvestingCap - U64!
kiAvailableToHarvest - U64
hasMaxKi - Boolean
rentalAgreement - GenoRentalAgreement
parentHabitatData - GenoHabitat
subHabitatData - [GenoHabitat]!
nft - Nft
Example
{
  "address": PublicKey,
  "habitatMint": PublicKey,
  "level": 123,
  "element": 987,
  "genesis": false,
  "renewalTimestamp": DateTimeUtc,
  "expiryTimestamp": DateTimeUtc,
  "nextDayTimestamp": DateTimeUtc,
  "crystalsRefined": 987,
  "harvester": "abc123",
  "kiHarvested": U64,
  "seedsSpawned": false,
  "isSubHabitat": true,
  "parentHabitat": PublicKey,
  "subHabitats": [PublicKey],
  "harvesterRoyaltyBips": 123,
  "harvesterOpenMarket": false,
  "totalKiHarvested": I64,
  "totalCrystalsRefined": I64,
  "terraformingHabitat": PublicKey,
  "active": true,
  "durability": 987,
  "habitatsTerraformed": 123,
  "sequence": I64,
  "guild": 123,
  "subHabitatCooldownTimestamp": DateTimeUtc,
  "harvesterSettingsCooldownTimestamp": DateTimeUtc,
  "dailyKiHarvestingCap": U64,
  "kiAvailableToHarvest": U64,
  "hasMaxKi": false,
  "rentalAgreement": GenoRentalAgreement,
  "parentHabitatData": GenoHabitat,
  "subHabitatData": [GenoHabitat],
  "nft": Nft
}

GenoHabitatList

Description

A list of Genopets habitats

Fields
Field Name Description
habitats - [GenoHabitat!]!
totalCountHint - I64
Example
{
  "habitats": [GenoHabitat],
  "totalCountHint": I64
}

GenoHabitatSortField

Description

Input sorting parameter for the genoHabitatsCounted query

Values
Enum Value Description

ADDRESS

Sort by the address field

LEVEL

Sort by the level field

LIFESPAN

Sort by the expiryTimestamp field

KI_HARVESTED

Sort by the kiHarvested field

CRYSTALS_REFINED

Sort by the crystalsRefined field

TOTAL_KI_HARVESTED

Sort by the totalKiHarvested field

KI_AVAILABLE_TO_HARVEST

Sort by the kiAvailableToHarvest field
Example
"ADDRESS"

GenoHabitatsParams

Description

Input parameters for the genoHabitatsCounted query

Fields
Input Field Description
mints - [PublicKey!] Filter by habitat NFT addresses
owners - [PublicKey!] Filter by habitat NFT owners
renters - [PublicKey!] Filter by renter addresses
harvesters - [String!] Filter by harvester addresses
genesis - Boolean Filter by genesis (or non-genesis)
elements - [Int!] Filter by elements
minLevel - Int Minimum habitat level to return
maxLevel - Int Maximum habitat level to return
minSequence - Int Minimum habitat sequence number to return
maxSequence - Int Maximum habitat sequence number to return
guilds - [Int!] Filter by guild IDs
minDurability - Int Minimum habitat durability to return
maxDurability - Int Maximum habitat durability to return
minExpiry - DateTimeUtc Minimum habitat expiry timestamp to return
maxExpiry - DateTimeUtc Maximum habitat expiry timestamp to return
harvesterOpenMarket - Boolean Filter by open (or closed) market
rentalOpenMarket - Boolean Filter by rental open (or closed) market
hasHarvester - Boolean
hasAlchemist - Boolean
hasMaxKi - Boolean
isActivated - Boolean
term - String Filter habitats by a fuzzy text-search query
sortField - GenoHabitatSortField Field to sort results by (default ADDRESS)
sortDesc - Boolean True to sort results in descending order (default false)
limit - Int! Maximum number of results to return (max 250)
offset - Int! Pagination offset
Example
{
  "mints": [PublicKey],
  "owners": [PublicKey],
  "renters": [PublicKey],
  "harvesters": ["xyz789"],
  "genesis": true,
  "elements": [987],
  "minLevel": 123,
  "maxLevel": 987,
  "minSequence": 123,
  "maxSequence": 123,
  "guilds": [987],
  "minDurability": 123,
  "maxDurability": 123,
  "minExpiry": DateTimeUtc,
  "maxExpiry": DateTimeUtc,
  "harvesterOpenMarket": true,
  "rentalOpenMarket": false,
  "hasHarvester": false,
  "hasAlchemist": false,
  "hasMaxKi": false,
  "isActivated": true,
  "term": "abc123",
  "sortField": "ADDRESS",
  "sortDesc": true,
  "limit": 987,
  "offset": 987
}

GenoRentalAgreement

Fields
Field Name Description
habitatAddress - PublicKey!
alchemist - PublicKey
rentalPeriod - I64!
rent - I64!
rentToken - PublicKey!
rentTokenDecimals - Int!
lastRentPayment - DateTimeUtc!
nextPaymentDue - DateTimeUtc!
gracePeriod - I64!
openMarket - Boolean!
Example
{
  "habitatAddress": PublicKey,
  "alchemist": PublicKey,
  "rentalPeriod": I64,
  "rent": I64,
  "rentToken": PublicKey,
  "rentTokenDecimals": 123,
  "lastRentPayment": DateTimeUtc,
  "nextPaymentDue": DateTimeUtc,
  "gracePeriod": I64,
  "openMarket": false
}

Governance

Fields
Field Name Description
address - PublicKey!
accountType - GovernanceAccountType!
governedAccount - PublicKey!
proposalsCount - I64!
votingProposalCount - Int!
governanceConfig - GovernanceConfig
realm - Realm
Example
{
  "address": PublicKey,
  "accountType": "UNINITIALIZED",
  "governedAccount": PublicKey,
  "proposalsCount": I64,
  "votingProposalCount": 987,
  "governanceConfig": GovernanceConfig,
  "realm": Realm
}

GovernanceAccountType

Values
Enum Value Description

UNINITIALIZED

REALM_V1

TOKEN_OWNER_RECORD_V1

GOVERNANCE_V1

PROGRAM_GOVERNANCE_V1

PROPOSAL_V1

SIGNATORY_RECORD_V1

VOTE_RECORD_V1

PROPOSAL_INSTRUCTION_V1

MINT_GOVERNANCE_V1

TOKEN_GOVERNANCE_V1

REALM_CONFIG

VOTE_RECORD_V2

PROPOSAL_TRANSACTION_V2

PROPOSAL_V2

PROGRAM_METADATA

REALM_V2

TOKEN_OWNER_RECORD_V2

GOVERNANCE_V2

PROGRAM_GOVERNANCE_V2

MINT_GOVERNANCE_V2

TOKEN_GOVERNANCE_V2

SIGNATORY_RECORD_V2

Example
"UNINITIALIZED"

GovernanceConfig

Fields
Field Name Description
governanceAddress - PublicKey!
voteThresholdType - VoteThreshold!
voteThresholdPercentage - Int!
minCommunityWeightToCreateProposal - U64!
minInstructionHoldUpTime - I64!
maxVotingTime - I64!
voteTipping - VoteTipping!
proposalCoolOffTime - I64!
minCouncilWeightToCreateProposal - I64!
Example
{
  "governanceAddress": PublicKey,
  "voteThresholdType": "YES_VOTE",
  "voteThresholdPercentage": 123,
  "minCommunityWeightToCreateProposal": U64,
  "minInstructionHoldUpTime": I64,
  "maxVotingTime": I64,
  "voteTipping": "STRICT",
  "proposalCoolOffTime": I64,
  "minCouncilWeightToCreateProposal": I64
}

GraphConnection

Fields
Field Name Description
address - String!
from - Wallet!
to - Wallet!
connectedAt - DateTimeUtc!
Example
{
  "address": "abc123",
  "from": Wallet,
  "to": Wallet,
  "connectedAt": DateTimeUtc
}

I64

Description

I64

Example
I64

InstructionExecutionFlags

Values
Enum Value Description

NONE

ORDERED

USE_TRANSACTION

Example
"NONE"

Int

Example
987

LastSale

Fields
Field Name Description
price - U64
createdAt - DateTimeUtc
purchase - Purchase
Example
{
  "price": U64,
  "createdAt": DateTimeUtc,
  "purchase": Purchase
}

Listing

Fields
Field Name Description
address - String!
extAddress - String!
cacheAddress - String!
storeAddress - String!
endsAt - DateTimeUtc
ended - Boolean!
storefront - Storefront
nfts - [Nft!]!
bids - [Bid!]!
Example
{
  "address": "abc123",
  "extAddress": "xyz789",
  "cacheAddress": "abc123",
  "storeAddress": "xyz789",
  "endsAt": DateTimeUtc,
  "ended": false,
  "storefront": Storefront,
  "nfts": [Nft],
  "bids": [Bid]
}

ListingEvent

Fields
Field Name Description
createdAt - DateTimeUtc!
walletAddress - PublicKey!
profile - TwitterProfile
feedEventId - String!
lifecycle - String!
listingId - Uuid!
listing - AhListing
wallet - Wallet!
Example
{
  "createdAt": DateTimeUtc,
  "walletAddress": PublicKey,
  "profile": TwitterProfile,
  "feedEventId": "abc123",
  "lifecycle": "abc123",
  "listingId": Uuid,
  "listing": AhListing,
  "wallet": Wallet
}

MarketStats

Fields
Field Name Description
nfts - U64
Example
{"nfts": U64}

Marketplace

Fields
Field Name Description
configAddress - PublicKey!
subdomain - String!
name - String!
description - String!
logoUrl - String!
bannerUrl - String!
ownerAddress - String!
storeAddress - PublicKey
auctionHouses - [AuctionHouse!]!
creators - [StoreCreator!]!
stats - MarketStats
Example
{
  "configAddress": PublicKey,
  "subdomain": "xyz789",
  "name": "abc123",
  "description": "xyz789",
  "logoUrl": "abc123",
  "bannerUrl": "abc123",
  "ownerAddress": "abc123",
  "storeAddress": PublicKey,
  "auctionHouses": [AuctionHouse],
  "creators": [StoreCreator],
  "stats": MarketStats
}

MetadataJson

Fields
Field Name Description
address - String!
name - String!
mintAddress - String!
image - String
creatorAddress - String
creatorTwitterHandle - String
Example
{
  "address": "xyz789",
  "name": "xyz789",
  "mintAddress": "abc123",
  "image": "abc123",
  "creatorAddress": "xyz789",
  "creatorTwitterHandle": "abc123"
}

MintEvent

Fields
Field Name Description
createdAt - DateTimeUtc!
walletAddress - PublicKey!
profile - TwitterProfile
feedEventId - String!
metadataAddress - PublicKey!
nft - Nft
wallet - Wallet!
Example
{
  "createdAt": DateTimeUtc,
  "walletAddress": PublicKey,
  "profile": TwitterProfile,
  "feedEventId": "xyz789",
  "metadataAddress": PublicKey,
  "nft": Nft,
  "wallet": Wallet
}

MintMaxVoteWeightSource

Values
Enum Value Description

SUPPLY_FRACTION

ABSOLUTE

Example
"SUPPLY_FRACTION"

MintStats

Fields
Field Name Description
mint - String!
floor - U64
average - U64
volume24hr - U64
volumeTotal - U64
auctionHouse - AuctionHouse
Example
{
  "mint": "abc123",
  "floor": U64,
  "average": U64,
  "volume24hr": U64,
  "volumeTotal": U64,
  "auctionHouse": AuctionHouse
}

MultiChoice

Fields
Field Name Description
maxVoterOptions - Int!
maxWinningOptions - Int!
Example
{"maxVoterOptions": 123, "maxWinningOptions": 987}

NaiveDateTime

Description

NaiveDateTime

Example
NaiveDateTime

Nft

Fields
Field Name Description
address - String!
name - String!
sellerFeeBasisPoints - Int!
mintAddress - String!
tokenAccountAddress - String!
primarySaleHappened - Boolean!
updateAuthorityAddress - String!
description - String!
category - String!
parser - String

The JSON parser with which the NFT was processed by the indexer

  • "full" indicates the full Metaplex standard-compliant parser was used.
  • "minimal" (provided with an optional description of an error) indicates the full model failed to parse and a more lenient fallback parser with fewer fields was used instead.
image - String!
Arguments
width - Int

Image width possible values are:

  • 0 (Original size)
  • 100 (Tiny)
  • 400 (XSmall)
  • 600 (Small)
  • 800 (Medium)
  • 1400 (Large)

Any other value will return the original image size.

If no value is provided, it will return XSmall

imageOriginal - String! Get the original URL of the image as stored in the NFT's metadata
animationUrl - String
externalUrl - String
creators - [NftCreator!]!
attributes - [NftAttribute!]!
owner - NftOwner
activities - [NftActivity!]!
listings - [AhListing!]!
purchases - [Purchase!]!
offers - [Offer!]!
files - [NftFile!]!
collection - CollectionNFT
moonrankCollection - Collection
createdAt - DateTimeUtc
moonrankRank - I64
lastSale - LastSale
Example
{
  "address": "abc123",
  "name": "abc123",
  "sellerFeeBasisPoints": 123,
  "mintAddress": "xyz789",
  "tokenAccountAddress": "abc123",
  "primarySaleHappened": true,
  "updateAuthorityAddress": "xyz789",
  "description": "abc123",
  "category": "xyz789",
  "parser": "xyz789",
  "image": "xyz789",
  "imageOriginal": "xyz789",
  "animationUrl": "abc123",
  "externalUrl": "xyz789",
  "creators": [NftCreator],
  "attributes": [NftAttribute],
  "owner": NftOwner,
  "activities": [NftActivity],
  "listings": [AhListing],
  "purchases": [Purchase],
  "offers": [Offer],
  "files": [NftFile],
  "collection": CollectionNFT,
  "moonrankCollection": Collection,
  "createdAt": DateTimeUtc,
  "moonrankRank": I64,
  "lastSale": LastSale
}

NftActivity

Fields
Field Name Description
id - Uuid!
metadata - PublicKey!
price - U64!
createdAt - DateTimeUtc!
wallets - [Wallet!]!
activityType - String!
marketplaceProgramAddress - String!
nft - Nft
auctionHouse - AuctionHouse
Example
{
  "id": Uuid,
  "metadata": PublicKey,
  "price": U64,
  "createdAt": DateTimeUtc,
  "wallets": [Wallet],
  "activityType": "abc123",
  "marketplaceProgramAddress": "xyz789",
  "nft": Nft,
  "auctionHouse": AuctionHouse
}

NftAttribute

Fields
Field Name Description
metadataAddress - String!
value - String
traitType - String
Example
{
  "metadataAddress": "xyz789",
  "value": "abc123",
  "traitType": "abc123"
}

NftCount

Fields
Field Name Description
total - Int!
listed - Int!
Arguments
auctionHouses - [PublicKey!]

a list of auction house public keys

Example
{"total": 987, "listed": 123}

NftCreator

Fields
Field Name Description
address - String!
metadataAddress - String!
share - Int!
verified - Boolean!
position - Int
twitterHandle - String
profile - TwitterProfile
Example
{
  "address": "abc123",
  "metadataAddress": "xyz789",
  "share": 123,
  "verified": false,
  "position": 123,
  "twitterHandle": "abc123",
  "profile": TwitterProfile
}

NftFile

Fields
Field Name Description
metadataAddress - String!
uri - String!
fileType - String!
Example
{
  "metadataAddress": "abc123",
  "uri": "abc123",
  "fileType": "xyz789"
}

NftOwner

Fields
Field Name Description
address - String!
associatedTokenAccountAddress - String!
twitterHandle - String
profile - TwitterProfile
Example
{
  "address": "xyz789",
  "associatedTokenAccountAddress": "abc123",
  "twitterHandle": "abc123",
  "profile": TwitterProfile
}

NftSort

Description

Sorts results by price or listed at

Values
Enum Value Description

PRICE

LISTED_AT

Example
"PRICE"

NftsStats

Fields
Field Name Description
totalNfts - Int! The total number of indexed NFTs
buyNowListings - Int! The total number of buy-now listings
nftsWithActiveOffers - Int! The total number of NFTs with active offers
Example
{"totalNfts": 987, "buyNowListings": 123, "nftsWithActiveOffers": 123}

Numeric

Description

Numeric data type

Example
Numeric

Offer

Fields
Field Name Description
id - Uuid!
tradeState - String!
buyer - PublicKey!
buyerWallet - Wallet!
metadata - PublicKey!
price - U64!
purchaseId - Uuid
tradeStateBump - Int!
tokenAccount - String
createdAt - DateTimeUtc!
canceledAt - DateTimeUtc
tokenSize - Int!
marketplaceProgramAddress - String!
nft - Nft
auctionHouse - AuctionHouse
Example
{
  "id": Uuid,
  "tradeState": "abc123",
  "buyer": PublicKey,
  "buyerWallet": Wallet,
  "metadata": PublicKey,
  "price": U64,
  "purchaseId": Uuid,
  "tradeStateBump": 987,
  "tokenAccount": "xyz789",
  "createdAt": DateTimeUtc,
  "canceledAt": DateTimeUtc,
  "tokenSize": 987,
  "marketplaceProgramAddress": "abc123",
  "nft": Nft,
  "auctionHouse": AuctionHouse
}

OfferEvent

Fields
Field Name Description
createdAt - DateTimeUtc!
walletAddress - PublicKey!
profile - TwitterProfile
feedEventId - String!
lifecycle - String!
offerId - Uuid!
offer - Offer
wallet - Wallet!
Example
{
  "createdAt": DateTimeUtc,
  "walletAddress": PublicKey,
  "profile": TwitterProfile,
  "feedEventId": "abc123",
  "lifecycle": "xyz789",
  "offerId": Uuid,
  "offer": Offer,
  "wallet": Wallet
}

OfferType

Description

Sorts results by price or listed at

Values
Enum Value Description

OFFER_PLACED

OFFER_RECEIVED

Example
"OFFER_PLACED"

OptionVoteResult

Values
Enum Value Description

NONE

SUCCEEDED

DEFEATED

Example
"NONE"

OrderDirection

Description

Sorts results ascending or descending

Values
Enum Value Description

DESC

ASC

Example
"DESC"

PayoutOperation

Description

Reward center mathematical operands

Values
Enum Value Description

MULTIPLE

DIVIDE

Example
"MULTIPLE"

PriceChart

Fields
Field Name Description
listingFloor - [PricePoint!]!
salesAverage - [PricePoint!]!
totalVolume - [PricePoint!]!
Example
{
  "listingFloor": [PricePoint],
  "salesAverage": [PricePoint],
  "totalVolume": [PricePoint]
}

PricePoint

Fields
Field Name Description
price - U64!
date - DateTimeUtc!
Example
{"price": U64, "date": DateTimeUtc}

ProfilesStats

Fields
Field Name Description
totalProfiles - Int! The total number of indexed profiles
Example
{"totalProfiles": 987}

Proposal

Types
Union Types

ProposalV1

ProposalV2

Example
ProposalV1

ProposalOption

Fields
Field Name Description
proposalAddress - PublicKey!
label - String!
voteWeight - I64!
voteResult - OptionVoteResult!
transactionsExecutedCount - Int!
transactionsCount - Int!
transactionsNextIndex - Int!
Example
{
  "proposalAddress": PublicKey,
  "label": "abc123",
  "voteWeight": I64,
  "voteResult": "NONE",
  "transactionsExecutedCount": 987,
  "transactionsCount": 123,
  "transactionsNextIndex": 123
}

ProposalState

Values
Enum Value Description

DRAFT

SIGNING_OFF

VOTING

SUCCEEDED

EXECUTING

COMPLETED

CANCELLED

DEFEATED

EXECUTING_WITH_ERRORS

Example
"DRAFT"

ProposalV1

Fields
Field Name Description
address - PublicKey!
accountType - GovernanceAccountType!
governingTokenMint - PublicKey!
state - ProposalState!
signatoriesCount - Int!
signatoriesSignedOffCount - Int!
yesVotesCount - I64!
noVotesCount - I64!
instructionsExecutedCount - Int!
instructionsCount - Int!
instructionsNextIndex - Int!
draftAt - DateTimeUtc!
signingOffAt - DateTimeUtc
votingAt - DateTimeUtc
votingAtSlot - I64
votingCompletedAt - DateTimeUtc
executingAt - DateTimeUtc
closedAt - DateTimeUtc
executionFlags - InstructionExecutionFlags!
maxVoteWeight - I64
voteThresholdType - VoteThreshold
voteThresholdPercentage - Int
name - String!
description - String!
programId - PublicKey
governance - Governance
tokenOwnerRecord - TokenOwnerRecord
Example
{
  "address": PublicKey,
  "accountType": "UNINITIALIZED",
  "governingTokenMint": PublicKey,
  "state": "DRAFT",
  "signatoriesCount": 987,
  "signatoriesSignedOffCount": 123,
  "yesVotesCount": I64,
  "noVotesCount": I64,
  "instructionsExecutedCount": 987,
  "instructionsCount": 987,
  "instructionsNextIndex": 987,
  "draftAt": DateTimeUtc,
  "signingOffAt": DateTimeUtc,
  "votingAt": DateTimeUtc,
  "votingAtSlot": I64,
  "votingCompletedAt": DateTimeUtc,
  "executingAt": DateTimeUtc,
  "closedAt": DateTimeUtc,
  "executionFlags": "NONE",
  "maxVoteWeight": I64,
  "voteThresholdType": "YES_VOTE",
  "voteThresholdPercentage": 987,
  "name": "abc123",
  "description": "xyz789",
  "programId": PublicKey,
  "governance": Governance,
  "tokenOwnerRecord": TokenOwnerRecord
}

ProposalV2

Fields
Field Name Description
address - PublicKey!
governingTokenMint - PublicKey!
state - ProposalState!
signatoriesCount - Int!
signatoriesSignedOffCount - Int!
voteType - VoteType!
denyVoteWeight - I64
vetoVoteWeight - I64
abstainVoteWeight - I64
startVotingAt - DateTimeUtc
draftAt - DateTimeUtc!
signingOffAt - DateTimeUtc
votingAt - DateTimeUtc
votingAtSlot - I64
votingCompletedAt - DateTimeUtc
executingAt - DateTimeUtc
closedAt - DateTimeUtc
executionFlags - InstructionExecutionFlags!
maxVoteWeight - I64
maxVotingTime - I64
voteThresholdType - VoteThreshold
voteThresholdPercentage - Int
name - String!
description - String!
programId - PublicKey
multiChoice - MultiChoice
governance - Governance
tokenOwnerRecord - TokenOwnerRecord
proposalOptions - [ProposalOption!]!
Example
{
  "address": PublicKey,
  "governingTokenMint": PublicKey,
  "state": "DRAFT",
  "signatoriesCount": 123,
  "signatoriesSignedOffCount": 987,
  "voteType": "SINGLE_CHOICE",
  "denyVoteWeight": I64,
  "vetoVoteWeight": I64,
  "abstainVoteWeight": I64,
  "startVotingAt": DateTimeUtc,
  "draftAt": DateTimeUtc,
  "signingOffAt": DateTimeUtc,
  "votingAt": DateTimeUtc,
  "votingAtSlot": I64,
  "votingCompletedAt": DateTimeUtc,
  "executingAt": DateTimeUtc,
  "closedAt": DateTimeUtc,
  "executionFlags": "NONE",
  "maxVoteWeight": I64,
  "maxVotingTime": I64,
  "voteThresholdType": "YES_VOTE",
  "voteThresholdPercentage": 123,
  "name": "xyz789",
  "description": "xyz789",
  "programId": PublicKey,
  "multiChoice": MultiChoice,
  "governance": Governance,
  "tokenOwnerRecord": TokenOwnerRecord,
  "proposalOptions": [ProposalOption]
}

PublicKey

Description

PublicKey

Example
PublicKey

Purchase

Fields
Field Name Description
id - Uuid!
buyer - PublicKey!
seller - PublicKey!
metadata - PublicKey!
price - U64!
createdAt - DateTimeUtc!
tokenSize - Int!
marketplaceProgramAddress - String!
nft - Nft
auctionHouse - AuctionHouse
Example
{
  "id": Uuid,
  "buyer": PublicKey,
  "seller": PublicKey,
  "metadata": PublicKey,
  "price": U64,
  "createdAt": DateTimeUtc,
  "tokenSize": 123,
  "marketplaceProgramAddress": "abc123",
  "nft": Nft,
  "auctionHouse": AuctionHouse
}

PurchaseEvent

Fields
Field Name Description
createdAt - DateTimeUtc!
walletAddress - PublicKey!
profile - TwitterProfile
feedEventId - String!
purchaseId - Uuid!
purchase - Purchase
wallet - Wallet!
Example
{
  "createdAt": DateTimeUtc,
  "walletAddress": PublicKey,
  "profile": TwitterProfile,
  "feedEventId": "abc123",
  "purchaseId": Uuid,
  "purchase": Purchase,
  "wallet": Wallet
}

Realm

Fields
Field Name Description
address - PublicKey!
accountType - GovernanceAccountType!
communityMint - PublicKey!
votingProposalCount - Int!
authority - PublicKey
name - String!
programId - PublicKey
realmConfig - RealmConfig
Example
{
  "address": PublicKey,
  "accountType": "UNINITIALIZED",
  "communityMint": PublicKey,
  "votingProposalCount": 123,
  "authority": PublicKey,
  "name": "xyz789",
  "programId": PublicKey,
  "realmConfig": RealmConfig
}

RealmConfig

Fields
Field Name Description
realmAddress - PublicKey!
useCommunityVoterWeightAddin - Boolean!
useMaxCommunityVoterWeightAddin - Boolean!
minCommunityWeightToCreateGovernance - U64!
communityMintMaxVoteWeightSource - MintMaxVoteWeightSource!
communityMintMaxVoteWeight - I64!
councilMint - PublicKey
Example
{
  "realmAddress": PublicKey,
  "useCommunityVoterWeightAddin": false,
  "useMaxCommunityVoterWeightAddin": false,
  "minCommunityWeightToCreateGovernance": U64,
  "communityMintMaxVoteWeightSource": "SUPPLY_FRACTION",
  "communityMintMaxVoteWeight": I64,
  "councilMint": PublicKey
}

RewardCenter

Fields
Field Name Description
address - PublicKey!
tokenMint - PublicKey!
auctionHouse - PublicKey!
bump - Int!
sellerRewardPayoutBasisPoints - Int!
mathematicalOperand - PayoutOperation!
payoutNumeral - Int!
slot - U64!
writeVersion - U64!
payouts - [RewardPayout!]!
Arguments
limit - Int!
offset - Int!
Example
{
  "address": PublicKey,
  "tokenMint": PublicKey,
  "auctionHouse": PublicKey,
  "bump": 987,
  "sellerRewardPayoutBasisPoints": 987,
  "mathematicalOperand": "MULTIPLE",
  "payoutNumeral": 123,
  "slot": U64,
  "writeVersion": U64,
  "payouts": [RewardPayout]
}

RewardPayout

Fields
Field Name Description
purchaseId - Uuid!
nft - Nft
purchase - Purchase
rewardCenter - PublicKey!
buyer - Wallet!
buyerReward - U64!
seller - Wallet!
sellerReward - U64!
createdAt - DateTimeUtc!
Example
{
  "purchaseId": Uuid,
  "nft": Nft,
  "purchase": Purchase,
  "rewardCenter": PublicKey,
  "buyer": Wallet,
  "buyerReward": U64,
  "seller": Wallet,
  "sellerReward": U64,
  "createdAt": DateTimeUtc
}

SignatoryRecord

Fields
Field Name Description
address - PublicKey!
accountType - GovernanceAccountType!
signatory - PublicKey!
signedOff - Boolean!
proposal - Proposal
Example
{
  "address": PublicKey,
  "accountType": "UNINITIALIZED",
  "signatory": PublicKey,
  "signedOff": false,
  "proposal": ProposalV1
}

SolanaNetwork

Fields
Field Name Description
tps - Int!
price - Float!
Arguments
currency - Currency!
Example
{"tps": 987, "price": 123.45}

StoreCreator

Fields
Field Name Description
storeConfigAddress - String!
creatorAddress - String!
twitterHandle - String
preview - [Nft!]!
profile - TwitterProfile
nftCount - Int
Example
{
  "storeConfigAddress": "abc123",
  "creatorAddress": "xyz789",
  "twitterHandle": "abc123",
  "preview": [Nft],
  "profile": TwitterProfile,
  "nftCount": 987
}

Storefront

Description

A Metaplex storefront

Fields
Field Name Description
address - String!
ownerAddress - String!
subdomain - String!
title - String!
description - String!
faviconUrl - String!
logoUrl - String!
bannerUrl - String!
Example
{
  "address": "xyz789",
  "ownerAddress": "abc123",
  "subdomain": "abc123",
  "title": "abc123",
  "description": "abc123",
  "faviconUrl": "abc123",
  "logoUrl": "abc123",
  "bannerUrl": "xyz789"
}

String

Example
"xyz789"

Timeseries

Fields
Field Name Description
floorPrice - [Datapoint!]!
listedCount - [Datapoint!]!
ownersCount - [Datapoint!]!
Example
{
  "floorPrice": [Datapoint],
  "listedCount": [Datapoint],
  "ownersCount": [Datapoint]
}

TokenOwnerRecord

Fields
Field Name Description
address - PublicKey!
accountType - GovernanceAccountType!
governingTokenMint - PublicKey!
governingTokenOwner - PublicKey!
governingTokenDepositAmount - I64!
unrelinquishedVotesCount - I64!
totalVotesCount - I64!
outstandingProposalCount - Int!
governanceDelegate - PublicKey
realm - Realm
Example
{
  "address": PublicKey,
  "accountType": "UNINITIALIZED",
  "governingTokenMint": PublicKey,
  "governingTokenOwner": PublicKey,
  "governingTokenDepositAmount": I64,
  "unrelinquishedVotesCount": I64,
  "totalVotesCount": I64,
  "outstandingProposalCount": 123,
  "governanceDelegate": PublicKey,
  "realm": Realm
}

TwitterProfile

Fields
Field Name Description
walletAddress - String
handle - String!
profileImageUrl - String! Use profileImageUrlLowres instead.
profileImageUrlLowres - String!
profileImageUrlHighres - String!
bannerImageUrl - String!
description - String!
Example
{
  "walletAddress": "abc123",
  "handle": "abc123",
  "profileImageUrl": "abc123",
  "profileImageUrlLowres": "abc123",
  "profileImageUrlHighres": "abc123",
  "bannerImageUrl": "xyz789",
  "description": "abc123"
}

U64

Description

U64

Example
U64

Uuid

Description

Uuid

Example
Uuid

Vote

Values
Enum Value Description

APPROVE

DENY

ABSTAIN

VETO

Example
"APPROVE"

VoteChoice

Fields
Field Name Description
address - PublicKey!
rank - Int!
weightPercentage - Int!
Example
{
  "address": PublicKey,
  "rank": 123,
  "weightPercentage": 123
}

VoteRecord

Types
Union Types

VoteRecordV1

VoteRecordV2

Example
VoteRecordV1

VoteRecordV1

Fields
Field Name Description
address - PublicKey!
governingTokenOwner - PublicKey!
isRelinquished - Boolean!
voteWeight - I64!
voteType - VoteWeightV1!
proposal - ProposalV1
tokenOwnerRecords - [TokenOwnerRecord!]!
Example
{
  "address": PublicKey,
  "governingTokenOwner": PublicKey,
  "isRelinquished": true,
  "voteWeight": I64,
  "voteType": "YES",
  "proposal": ProposalV1,
  "tokenOwnerRecords": [TokenOwnerRecord]
}

VoteRecordV2

Fields
Field Name Description
address - PublicKey!
governingTokenOwner - PublicKey!
isRelinquished - Boolean!
voterWeight - I64!
vote - Vote!
approveVoteChoices - [VoteChoice!]!
proposal - ProposalV2
tokenOwnerRecords - [TokenOwnerRecord!]!
Example
{
  "address": PublicKey,
  "governingTokenOwner": PublicKey,
  "isRelinquished": false,
  "voterWeight": I64,
  "vote": "APPROVE",
  "approveVoteChoices": [VoteChoice],
  "proposal": ProposalV2,
  "tokenOwnerRecords": [TokenOwnerRecord]
}

VoteThreshold

Values
Enum Value Description

YES_VOTE

QUORUM

Example
"YES_VOTE"

VoteTipping

Values
Enum Value Description

STRICT

EARLY

DISABLED

Example
"STRICT"

VoteType

Values
Enum Value Description

SINGLE_CHOICE

MULTI_CHOICE

Example
"SINGLE_CHOICE"

VoteWeightV1

Values
Enum Value Description

YES

NO

Example
"YES"

Wallet

Fields
Field Name Description
address - PublicKey!
twitterHandle - String
nfts - [Nft!]!
Arguments
auctionHouse - String
marketplaceProgram - String
collections - [String!]
sortBy - NftSort
orderBy - OrderDirection
limit - Int!
offset - Int!
associatedTokenAccounts - [AssociatedTokenAccount!]!
Arguments
mintAddress - PublicKey
collectedCollections - [CollectedCollection!]!
activities - [WalletActivity!]!
Arguments
eventTypes - [String!]
limit - Int!
offset - Int!
offers - [Offer!]!
Arguments
offerType - OfferType
limit - Int!
offset - Int!
bids - [Bid!]!
profile - TwitterProfile
connectionCounts - ConnectionCounts!
nftCounts - WalletNftCount!
Arguments
creators - [PublicKey!]

a list of auction house public keys

totalRewards - U64!
Arguments
rewardCenter - PublicKey!
Example
{
  "address": PublicKey,
  "twitterHandle": "xyz789",
  "nfts": [Nft],
  "associatedTokenAccounts": [AssociatedTokenAccount],
  "collectedCollections": [CollectedCollection],
  "activities": [WalletActivity],
  "offers": [Offer],
  "bids": [Bid],
  "profile": TwitterProfile,
  "connectionCounts": ConnectionCounts,
  "nftCounts": WalletNftCount,
  "totalRewards": U64
}

WalletActivity

Fields
Field Name Description
id - Uuid!
metadata - PublicKey!
price - U64!
createdAt - DateTimeUtc!
wallets - [Wallet!]!
activityType - String!
marketplaceProgramAddress - String!
nft - Nft
auctionHouse - AuctionHouse
Example
{
  "id": Uuid,
  "metadata": PublicKey,
  "price": U64,
  "createdAt": DateTimeUtc,
  "wallets": [Wallet],
  "activityType": "abc123",
  "marketplaceProgramAddress": "abc123",
  "nft": Nft,
  "auctionHouse": AuctionHouse
}

WalletNftCount

Fields
Field Name Description
owned - Int!
offered - Int!
Arguments
auctionHouses - [PublicKey!]

auction houses to scope wallet counts

listed - Int!
Arguments
auctionHouses - [PublicKey!]

auction houses to scope wallet counts

created - Int!
Example
{"owned": 123, "offered": 123, "listed": 987, "created": 123}