GraphQL API

CarbonMarketsHQ exposes data as a single composable GraphQL API. GraphQL is a powerful query language for APIs that allows clients to request exactly the data they need. It provides a flexible and efficient approach to querying data, making it an excellent choice for modern API development. In this document, we'll cover the basic concepts of GraphQL and points you to the steps to explore our GraphQL API using Postman.

Basic GraphQL Concepts

1. Queries: Queries are used to fetch data from the GraphQL server. They specify the fields and nested fields you want to retrieve from the server. Queries are read-only operations and do not modify any data.

2. Mutations: Mutations are used to modify data on the GraphQL server. They allow you to create, update, or delete data. Mutations typically require authentication and authorization.

3. Types: GraphQL uses a strongly typed schema to define the structure of the data. Each type represents an object with a set of fields. Types can be scalar (e.g., String, Int, Boolean) or custom objects.

4. Fields: Fields are the properties of a type. They define the data that can be queried or mutated for a particular type. Fields can have arguments to filter or modify the returned data.

5. Arguments: Arguments are used to pass data to fields or mutations. They allow you to provide input values to filter, sort, or modify the requested data.

6. Variables: Variables are used to pass dynamic values to queries or mutations. They are defined in the query or mutation and can be used in place of static values.

You can install Postman and read their documentation on Creating GraphQL requests to explore our API.

API Reference

Find the query pattern and complete list of response fields in API reference document.

API reference