TypeScript SDK for thegraph.com API

GraphQL client for the
thegraph.com API

The Graph is an indexing protocol for organizing blockchain data and making it easily accessible with GraphQL.

This SDK was created from the thegraph.com GraphQL API with Genql.

This library is fully type safe and thanks to TypeScript auto completion you can discover fields and methods very easily.

How to install

Use a package manager to install the API client

bash
npm install @genql/thegraph

Using the client

Use a package manager to install the API client

typescript
import { createClient } from '@genql/thegraph'
const client = createClient()

Passing headers

You can use the headers options to pass credentials or other headers

typescript
import { createClient } from '@genql/thegraph'
const client = createClient({
    headers: {
        Authorization: `Bearer ${Token}`
    }
})

Example queries

This SDK is generated from the thegraph.com GraphQL API so the client has a structure similar to the one used by GraphQL queries.

To fetch fields you need to explicitly pass field: true, you can also pass __args to fetch all scalar fields on a type.

Notice that to pass arguments you can use __args

typescript
import { createClient } from '@genql/thegraph'
const client = createClient()


// query variables
let subgraphId = ''

client
  .query({
    apiVersions: {
      __args: {
        subgraphId: subgraphId,
      },
      version: true,
    },
  })
  .then((x) => console.log(JSON.stringify(x, null, 4)))



// query variables
let blockHash
let network = ''

client
  .query({
    blockData: {
      __args: {
        blockHash: blockHash,
        network: network,
      },
    },
  })
  .then((x) => console.log(JSON.stringify(x, null, 4)))

More usage examples

This SDK was created using Genql so you can find more usage examples in the main Genql website and docs

Other API clients

wapm.io SDK tezos.domains SDK See all SDK available