Bored Ape Yacht Club Subgraph & API

This is a subgraph that enables the indexing and querying of data from the Bored Ape Yacht Club and Mutant Ape Yacht Club NFTs / smart contracts using The Graph

You can perform relational queries, full text search, sorting, and filtering using this API.

Using the subgraph

The subgraph is located in the Graph Explorer at https://thegraph.com/legacy-explorer/subgraph/dabit3/boredapeyachtclub.

You can use it in your app by accessing this API endpoint:

https://api.thegraph.com/subgraphs/id/QmaQReZYZ7J6ergVLhmZFTrd7AenV46aJ8c2Y6ohdJ3Dbp

To learn how to query a subgraph with GraphQL, check out the docs here

Deploying your own version of the subgraph

First, clone the project:

git clone [email protected]:dabit3/bored-ape-yacht-club-api-and-subgraph.git

Next, change into the new directory and install the dependencies:

cd bored-ape-yacht-club-api-and-subgraph

npm install

Create an account on The Graph here.

Next, create a new subgraph in the Graph Hosted Service here

Before deploying, you need to first authenticate via the Graph CLI using the access token given to you in your account:

graph auth --product hosted-service <ACCESS_TOKEN>

Next, either update the code that you have, or deploy as is, updating the username and subgraph name with your own username + subgraph name:

graph deploy --product hosted-service <username/subgraph-name>

For instance, my deploy script will look like this:

graph deploy --product hosted-service dabit3/boredapeyachtclub

Queries

Basic query

{
  tokens {
    id
    tokenID
    contentURI
    collection
    eyes
    background
    hat
    mouth
    clothes
    fur
    earring
  }
}

Full Text Search

{
  tokenSearch (text: "Orange") {
    id
    tokenID
    contentURI
    collection
    eyes
    background
    hat
    mouth
    clothes
    fur
    earring
  }
}

Filtering

{
  tokens(
    where: {
      collection: "Mutant Ape Yacht Club"
    }
  ) {
    id
    tokenID
    contentURI
    collection
    eyes
    background
    hat
    mouth
    clothes
    fur
    earring
  }
}

Query tokens by owner

{
  tokens(
    where: {
      owner: "0x9056d15c49b19df52ffad1e6c11627f035c0c960"
    }
  ) {
    id
    tokenID
    contentURI
    collection
    eyes
    background
    hat
    mouth
    clothes
    fur
    earring
  }
}

Relational data (tokens and owners)

{
  tokens {
    id
    tokenID
    contentURI
    collection
    eyes
    background
    hat
    mouth
    clothes
    fur
    earring
    owner {
      id
      tokens {
        id
      }
    }
  }
}

Change order direction

{
  tokens(
    orderBy: updatedAtTimestamp
    orderDirection: desc
  ) {
    id
    tokenID
    contentURI
    collection
    eyes
    background
    hat
    mouth
    clothes
    fur
    earring
  }
}

Working with IPFS in a subgraph

This project can also serve as a useful reference for how to query IPFS from within a subgraph mapping template, using methods like ipfs.cat from the graph-ts library and how to manage the data once it comes back from IPFS:

let data = ipfs.cat(ipfshash)

let value = json.fromBytes(data!).toObject()

let attributes = value.get('attributes').toArray()

for (let i = 0; i < attributes.length; i++) {
  let item = attributes[i].toObject()
  // do stuff
}