GraphQL API

Open GraphQL API Reference docs

GraphQL API

What is Vega Node GraphQL API and why should I use it over REST?

GraphQL is a query language and server-side runtime for APIs that prioritises giving clients exactly the data they request and no more. It is designed to make APIs fast, flexible, and developer-friendly. GraphQL was created to cope with the need for more flexibility and efficiency. It solves many of the shortcomings and inefficiencies that developers experience when interacting with REST APIs.

Test your queries with GraphQL Playground on Vega

The GraphQL Playground is an interactive web app which enables developers to build and test out custom queries graphically before embedding them into their applications.

Open GraphQL Playground app

How do I use the GraphQL Playground?

GraphQL Playground is a web based tool to get easily start testing and developing queries for the Vega APIs before integrating them into a codebase. Open the tool by using the link above and get started writing your first query in the tab presented (you can open and save multiple tabs). Conveniently, all the API docs and schema information are available whilst in the Playground and these are located on the right hand side under the two tabs “Docs” and “Schema”. The integration is very tight and the comments provide clarity for building your queries, mutations and subscriptions.