{"id":21660207,"url":"https://github.com/Consensys/ethql","last_synced_at":"2025-07-17T23:31:05.310Z","repository":{"id":45032334,"uuid":"121815589","full_name":"Consensys/ethql","owner":"Consensys","description":"A GraphQL interface to Ethereum :fire:","archived":true,"fork":false,"pushed_at":"2022-01-13T10:12:07.000Z","size":4288,"stargazers_count":624,"open_issues_count":48,"forks_count":85,"subscribers_count":53,"default_branch":"master","last_synced_at":"2024-11-14T17:48:16.952Z","etag":null,"topics":["api","backend","blockchain","ethereum","frontend","graphql","indexing","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Consensys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-17T00:34:40.000Z","updated_at":"2024-11-13T02:26:07.000Z","dependencies_parsed_at":"2022-07-26T10:32:19.467Z","dependency_job_id":null,"html_url":"https://github.com/Consensys/ethql","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fethql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fethql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fethql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fethql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Consensys","download_url":"https://codeload.github.com/Consensys/ethql/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226306138,"owners_count":17603937,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","backend","blockchain","ethereum","frontend","graphql","indexing","typescript"],"created_at":"2024-11-25T09:32:29.689Z","updated_at":"2024-11-25T09:34:30.724Z","avatar_url":"https://github.com/Consensys.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# A GraphQL interface to Ethereum 🔥 \n\n[![CircleCI](https://circleci.com/gh/ConsenSys/ethql.svg?style=svg)](https://circleci.com/gh/ConsenSys/ethql)\n[![Gitter](https://img.shields.io/gitter/room/ethql/lobby.js.svg?style=flat-square)](https://gitter.im/ethql/Lobby)\n\n**▶️ Try out the Alpha on Infura:\n[https://ethql-alpha.infura.io/graphql](\u003chttps://ethql-alpha.infura.io/graphql?query=%7B%0A%20%20block(number%3A%205000000)%20%7B%0A%20%20%20%20hash%0A%20%20%20%20transactions(filter%3A%20%7B%20withInput%3A%20true%20%7D)%20%7B%0A%20%20%20%20%20%20index%0A%20%20%20%20%20%20hash%0A%20%20%20%20%20%20from%20%7B%0A%20%20%20%20%20%20%20%20address%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20to%20%7B%0A%20%20%20%20%20%20%20%20address%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20decoded%20%7B%0A%20%20%20%20%20%20%20%20entity%0A%20%20%20%20%20%20%20%20operation%0A%20%20%20%20%20%20%20%20standard%0A%20%20%20%20%20%20%20%20...%20on%20ERC20Transfer%20%7B%0A%20%20%20%20%20%20%20%20%20%20tokenContract%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20symbol%0A%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20from%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20account%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20address%0A%20%20%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20%20%20tokenBalance%0A%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20to%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20account%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20address%0A%20%20%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20value%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A%0A%0A\u003e)**\n\n[Example queries.](#query-handbook)\n\nEthQL is a server that exposes a GraphQL endpoint to the public Ethereum ledger. It works against the standard JSON-RPC\nAPIs offered by all Ethereum clients. It is built in TypeScript, and thus leverages the vast ecosystem of GraphQL\ntooling while preserving compile-time type safety.\n\nEthQL regards blockchain data as a graph, and leverages the extensibility of GraphQL to introduce additional\nfunctionality, amongst which are:\n\n- Decoding of standard transactions (e.g. ERC20, ENS, ERC223, etc.) out of the box.\n- New query patterns enabled by indexing solutions (e.g. all transactions between any two accounts).\n- Automatic batching and caching of requests.\n- New filtering capabilities.\n- Simple, inline unit conversions.\n- Enhancing public data with information overlays imported from other sources.\n\n_NOTE: This project is under heavy development._\n\n## Quickstart\n\nYou need a running Node environment with at least:\n\n- nodejs \u003e= 8.0.0\n- [yarn](https://yarnpkg.com/)\n\nClone the repo and run:\n\n```\n$ yarn install\n$ yarn bootstrap\n$ yarn run dev\nJSON-RPC (web3): Using HTTP(S) provider with endpoint: https://mainnet.infura.io/\nRunning a GraphQL API server at http://0.0.0.0:4000/graphql (browse here: http://localhost:4000/graphql)\n```\n\nThis EthQL server uses [Infura](https://infura.io/) as a backend in anonymous mode. If you have an Infura project ID (and if you don't, you should sign up for one!) you can set it like this:\n\n```\n$ INFURA_ID=myid yarn run dev\n```\n## Development\nThe `debug` module is included in Dev Dependencies\n\nTo turn on debugging:\n```\nDEBUG=ethql:*\n```\n\n## Query Handbook\n\nWe suggest fiddling with some [Example Use Cases](https://github.com/ConsenSys/ethql/wiki/Example-Use-Cases) to see some\nqueries in action.\n\nFor an in-depth guide on how to use EthQL, please start with the document\n[Top-Level Queries](https://github.com/ConsenSys/ethql/wiki/Top-Level-Queries). This document shows all of the root\nfields available to query, including information on specific block(s), transaction(s), and account(s).\n\nThe following sections provide a deep dive into all of the fields available on top-level queries:\n\n- [Block Query Fields](https://github.com/ConsenSys/ethql/wiki/Block-Query-Fields)\n- [Account Query Fields](https://github.com/ConsenSys/ethql/wiki/Account-Query-Fields)\n- [Transaction Query Fields](https://github.com/ConsenSys/ethql/wiki/Transaction-Query-Fields)\n- [Log Query Fields](https://github.com/ConsenSys/ethql/wiki/Log-Query-Fields)\n- [Decoded Transaction Query Fields](https://github.com/ConsenSys/ethql/wiki/Decoded-Transaction-Query-Fields)\n\n## Contributing\n\nIf you are interested in fixing issues and contributing directly to the code base, please see the document\n[How to Contribute](https://github.com/ConsenSys/ethql/wiki/How-to-Contribute), which covers the following:\n\n- [Submitting Bugs and Suggestions](https://github.com/ConsenSys/ethql/wiki/Submitting-Bugs-and-Suggestions)\n- [Feedback Channels](https://github.com/ConsenSys/ethql/wiki/Feedback-Channels)\n- [Coding Guidelines](https://github.com/ConsenSys/ethql/wiki/Coding-Guidelines)\n- [Contributor License Agreement](https://github.com/ConsenSys/ethql/wiki/Contributor-License-Agreement)\n\nPlease see also our [Code of Conduct](https://github.com/ConsenSys/ethql/wiki/Contributor-Code-of-Conduct).\n\n## Feedback\n\n- Request a new feature on [GitHub](https://github.com/ConsenSys/ethql/wiki/Submitting-Bugs-and-Suggestions).\n- Vote for\n  [popular feature requests](https://github.com/ConsenSys/ethql/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%22).\n- File a bug in [GitHub Issues](https://github.com/ConsenSys/ethql/issues).\n- [Tweet](https://twitter.com/PegasysEng) us with other feedback\n\n## Development team\n\n- Raúl Kripalani [(contact)](mailto:raul.kripalani@consensys.net)\n- Akhila Raju [(contact)](mailto:akhila.raju@consensys.net)\n\n# Who we are\n\n\u003ca href=\"https://pegasys.tech/?utm_source=github\u0026utm_medium=source\u0026utm_campaign=ethql\" rel=\"nofollow\"\u003e\u003cimg src=\"https://raw.github.com/ConsenSys/ethql/master/logo.svg?sanitize=true\" alt=\"PegaSys logo\" data-canonical-src=\"https://raw.github.com/ConsenSys/ethql/master/logo.svg?sanitize=true\" width=\"400\"\u003e\u003c/a\u003e\n\nPegaSys’ mission is to build blockchain solutions ready for production in business environments. We are committed to\nopen source, and are creating a framework for collaborative innovation for the public-chain community and leading\nenterprises.\n\nOur team is composed of engineers leading in the areas of big data processing, applied cryptography, open source\ncomputing, cloud services, and blockchain development.\n\n[Learn more about PegaSys.](https://pegasys.tech/?utm_source=github\u0026utm_medium=source\u0026utm_campaign=ethql)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FConsensys%2Fethql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FConsensys%2Fethql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FConsensys%2Fethql/lists"}