Galaxy API

GraphQL API Docs

Access to Galaxy is served up by a GraphQL (GQL) API at https://galaxy.rollup.id

To prevent abuse, the service limits requests for each application to 10 per minute.

Setup Guide

There are several ways you can consume GQL APIs and we've documented how below. If you are interested in a deeper understanding of GraphQL you can visit the GraphQL documentation portal.

For these examples we are using Javascript but you would be able to achieve similar results with your preferred language.

1. Simple Fetch

Option 1: Simple Fetch Client

A simple fetch client is the fastest way to consume a GQL API if you are not using GQL anywhere else in your application since this method requires no new dependencies.

Here is a simple example of using fetch with Galaxy.

const query = `query getProfile() {
  profile {
    displayName
    pfp
  }
}`

const { profile } = fetch("https://galaxy.rollup.id/graphql", {
  method: "post",
  headers: {
    "Authorization": `Bearer ${jwt}`,
    "X-GALAXY-KEY": "...",
  },
  body: JSON.stringify({ query }),
})
  .then(r => r.json())
  .catch(err => {
    console.error(err) // something went wrong
    return { profile: null }
  })

In this example we are calling the Galaxy "profile" resolver and asking it to return two fields.

Here is the same operation but with two resolvers this time:

const query = `query getProfile() {
  profile {
    displayName
    pfp
  }
  gallery {
    contract
    tokenId
  }
}

const { profile } = fetch("https://galaxy.rollup.id/graphql", {
  method: "post",
  headers: {
    "Authorization": "Bearer ${jwt}",
    "X-GALAXY-KEY": "...",
  },
  body: JSON.stringify({ query }),
})
  .then(r => r.json())
  .then(data => {
    return {
      ...data.profile,
      gallery
   }
  })
  .catch(err => {
    console.error(err) // something went wrong
    return { profile: null }
  })

In this example get two responses. One from "profile" and one from "gallery. Then we merge the response into one profile object. And here is one more example operation with variables:

const query = `query getProfileFromAlias($provider, $alias) {
  profile: profileFromAlias(provider: $provider, alias: $alias) {
    displayName
    pfp
  }
}

const { profile } = fetch("https://galaxy.rollup.id/graphql", {
  method: "post",
  headers: {
    "X-GALAXY-KEY": "...",
  },
  body: JSON.stringify({
    query,
    variables: {
      provider: "eth",
      alias: "vitalik.eth"
    }
  }),
})
  .then(r => r.json())
  .catch(err => {
    console.error(err) // something went wrong
    return { profile: null }
  })

2. GQL Client

Option 2: GraphQL Clients

Our recommended approach is to use a general purpose GQL Client. One such client we recommend for Javascript is graphql-request.

GraphQL Request helps reduce the overhead of making GQL API calls with a simple fetch. Let's demonstrate the same examples in Option 1 with this library.

First we setup a client:

const client = new GraphQLClient(endpoint, {
  headers: {
    Authorization: 'Bearer ${jwt}',
    'X-GALAXY-KEY': '...',
  },
})

Then we can do the single operation request:

const query = `query getProfile() {
  profile {
    displayName
    pfp
  }
}

const { profile } = client.request(query)

Just like in Option 1, in this example we are calling the Galaxy "profile" resolver and asking it to return two fields.

Let's do the same but with two resolvers this time:

const query = `query getProfile() {
  profile {
    displayName
    pfp
  }
  gallery {
    contract
    tokenId
  }
}

const { profile } = client.request(query).then(data => {
  return {
    ...data.profile,
    gallery
  }
})

Again, just like in Option 1, in this example get two responses. One from "profile" and one from "gallery. Then we merge the response into one profile object. And finally, one more example operation with variables:

const query = `query getProfileFromAlias($provider, $alias) {
  profile: profileFromAlias(provider: $provider, alias: $alias) {
    displayName
    pfp
  }
}

const { profile } = client.request(query, {
  provider: "eth",
  alias: "vitalik.eth"
})

As you can see, with a GraphQL client lines the overhead of making API calls is greatly reduced.

3. GQL Codegen

Option 3: GraphQL Generator

This option is best if you already have GraphQL well integrated into your application and are looking to extend your GQL client.

A popular tool for generating client is the GraphQL Code Generator. With the generator you can reference the Galaxy API schema at http://galaxy.rollup.id in your codegen configuration and write your operation documents ahead of time too.

With this approach you can then reference your operations directly from your client. For example:

const { profile } = await myGeneratedClient.getProfileFromAddress({
  addressURN,
})

Definitions

X-Galaxy-Key Header

This is the API Key that can be found in the dashboard of your Console App and is required to authenticate into the Galaxy API.

Authorization Header

This is where you provide the JWT received from your user sessions after the token exchange during user login.

API Playground

To see the entire API definition you can explore the entire Galaxy API at the GQL playground.