Cardano GraphQL
Cross-platform, typed, and queryable API for Cardano. The project contains multiple packages for composing
GraphQL services to meet specific application demands, and a docker-compose stack serving the included
cardano-graphql-server Dockerfile, the extended hasura Dockerfile, cardano-node-ogmios. The schema is defined in
native .graphql
, and used to generate a TypeScript package for client-side static typing. A mutation is available to
submit a signed and serialized transaction to the local node.
Apollo Server exposes the NodeJS execution engine over a HTTP endpoint, and includes support for open source metrics
via Prometheus, and implementing operation filtering to deny unexpected queries. Should you wish to have more control
over the server, or stitch the schema with an existing service, consider importing the executable schema from the
@cardano-graphql/api-*
packages only.
GraphQL is a query language and execution environment with server and client implementations across many programming languages. The language can be serialized for network transmission, schema implementations hashed for assurance, and is suited for describing most domains.
TypeScript (and JS) has the largest pool of production-ready libraries, developers, and interoperability in the GraphQL and web ecosystem in general. TypeScript definitions for the schema, generated by GraphQL Code Generator, are available on npm.
Ogmios is a protocol translation service written in Haskell running on top of cardano-node. It offers a JSON interface through WebSockets and enables applications to speak Ouroboros' client mini-protocols via remote procedure calls.
Check the releases for the latest version.
git clone \
--single-branch \
--branch <VERSION> \
--recurse-submodules \
https://github.com/input-output-hk/cardano-graphql.git \
&& cd cardano-graphql
Builds @cardano-graphql/server
and starts it along with cardano-ogmios-node
, cardano-db-sync-extended
, postgresql
, and hasura
:
DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose up -d --build && docker-compose logs -f
ℹ️ Omit the --build
to use a pre-built image from Dockerhub (or locally cached from previous build)
Use the GraphQL Playground in the browser at http://localhost:3100/graphql:
{ cardanoDbMeta { initialized syncPercentage }}
or via command line:
curl \
-X POST \
-H "Content-Type: application/json" \
-d '{"query": "{ cardanoDbMeta { initialized syncPercentage }}"}' \
http://localhost:3100/graphql
ℹ️ Wait for initialized
to be true
to ensure the epoch dataset is complete. After the first sync
you may need to restart the services using docker-compose restart cardano-graphql
if the GraphQL server isn't running.
{ cardano { tip { number slotNo epoch { number } } } }
curl \
-X POST \
-H "Content-Type: application/json" \
-d '{"query": "{ cardano { tip { number slotNo epoch { number } } } }"}' http://localhost:3100/graphql
{ "data": { "cardano": { "tip": { "number": 4391749, "slotNo": 4393973, "epoch": { "number": 203 } } } } }
For more information, have a look at the Wiki 📖.
See Using Docker.
See Building.
Link | Audience |
---|---|
API Documentation | Users of the Cardano GraphQL API |
Wiki 📖 | Anyone interested in the project and our development process |
Example Queries - Cardano DB Hasura | Users of the Cardano DB Hasura API |