Skip to main content

GraphQL API Reference

About GraphQL

GraphQL is an API query language that is used broadly by Kraken. It allows you to query for all the information you want in a single request.

If GraphQL is new to you, information about how it works and how to form queries can be found on the GraphQL Foundation's website, and further reading can be found in the specification.

The query type defines GraphQL operations that retrieve data from the server.

The mutation type defines GraphQL operations that change data on the server.

Objects are the building blocks of GraphQL APIs. They represent the resources that can be accessed via the API.

Interfaces are abstract types that can be implemented by other objects.

Enums represent possible sets of values for a field.

Unions are abstract types that can be used to return one of a number of different objects.

An Input Object defines a set of input fields; the input fields are either scalars, enums, or other input objects.

Scalars represent primitive data types that can be returned from a GraphQL API.

Graphql Queries and Mutations can raise different kinds of errors; Kraken specifies many of our own, which you can find here.