{"id":20138311,"url":"https://github.com/pinax-network/substreams-erc20-api","last_synced_at":"2026-06-12T07:33:05.593Z","repository":{"id":205641462,"uuid":"704065610","full_name":"pinax-network/substreams-erc20-api","owner":"pinax-network","description":"substreams-erc20-api","archived":false,"fork":false,"pushed_at":"2024-05-28T15:13:29.000Z","size":35011,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2026-05-01T10:41:50.027Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pinax-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-12T13:16:53.000Z","updated_at":"2024-05-28T15:31:56.000Z","dependencies_parsed_at":"2023-11-14T21:25:40.305Z","dependency_job_id":"0dddcf91-dca7-46e7-954a-92008a869752","html_url":"https://github.com/pinax-network/substreams-erc20-api","commit_stats":null,"previous_names":["pinax-network/substreams-erc20-api"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/pinax-network/substreams-erc20-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinax-network%2Fsubstreams-erc20-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinax-network%2Fsubstreams-erc20-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinax-network%2Fsubstreams-erc20-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinax-network%2Fsubstreams-erc20-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pinax-network","download_url":"https://codeload.github.com/pinax-network/substreams-erc20-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinax-network%2Fsubstreams-erc20-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34234557,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-13T21:37:22.312Z","updated_at":"2026-06-12T07:33:05.575Z","avatar_url":"https://github.com/pinax-network.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [`Substreams`](https://substreams.streamingfast.io/) ERC20 API\n\n[![.github/workflows/bun-test.yml](https://github.com/pinax-network/substreams-erc20-api/actions/workflows/bun-test.yml/badge.svg)](https://github.com/pinax-network/substreams-erc20-api/actions/workflows/bun-test.yml)\n\n\u003e ERC-20 Balance, Supply, Contract API\n\n## REST API\n\n| Pathname        | Description                                             |\n| --------------- | ------------------------------------------------------- |\n| GET `/`         | [Swagger UI](https://swagger.io/resources/open-api/)    |\n| GET `/chains`   | Available `chains`                                      |\n| GET `/supply`   | ERC20 total supply                                      |\n| GET `/contract` | ERC20 contract information (name,symbol,decimals)       |\n| GET `/balance`  | ERC20 balance changes                                   |\n| GET `/holders`  | ERC20 contract's holders                                |\n| GET `/health`   | Health check                                            |\n| GET `/metrics`  | Prometheus metrics                                      |\n| GET `/openapi`  | [OpenAPI v3 JSON](https://spec.openapis.org/oas/v3.0.0) |\n\n## Requirements\n\n- [ClickHouse](clickhouse.com/)\n- [Substreams Sink ClickHouse](https://github.com/pinax-network/substreams-sink-clickhouse/)\n\n## Quickstart\n\n```console\n$ bun install\n$ bun dev\n```\n\n## [`Bun` Binary Releases](https://github.com/pinax-network/substreams-sink-websockets/releases)\n\n\u003e Linux Only\n\n```console\n$ wget https://github.com/pinax-network/substreams-erc20-api/releases/download/v0.0.1/substreams-erc20-api\n$ chmod +x ./substreams-erc20-api\n```\n\n## `.env` Environment variables\n\n```env\n# API Server\nPORT=8080\nHOSTNAME=localhost\n\n# Clickhouse Database\nHOST=http://127.0.0.1:8123\nDATABASE=default\nUSERNAME=default\nPASSWORD=\nMAX_LIMIT=500\n\n# Logging\nVERBOSE=true\n```\n\n## Help\n\n```console\n$ ./substreams-erc20-api --help\nUsage: substreams-erc20-api [options]\n\nERC20 API powered by Substreams\n\nOptions:\n  -V, --version            output the version number\n  -p, --port \u003cnumber\u003e      HTTP port on which to attach the API (default: \"8080\", env: PORT)\n  -v, --verbose \u003cboolean\u003e  Enable verbose logging (choices: \"true\", \"false\", default: false, env: VERBOSE)\n  --hostname \u003cstring\u003e      Server listen on HTTP hostname (default: \"localhost\", env: HOSTNAME)\n  --host \u003cstring\u003e          Database HTTP hostname (default: \"http://localhost:8123\", env: HOST)\n  --username \u003cstring\u003e      Database user (default: \"default\", env: USERNAME)\n  --password \u003cstring\u003e      Password associated with the specified username (default: \"\", env: PASSWORD)\n  --database \u003cstring\u003e      The database to use inside ClickHouse (default: \"default\", env: DATABASE)\n  --max-limit \u003cnumber\u003e     Maximum LIMIT queries (default: 10000, env: MAX_LIMIT)\n  -h, --help               display help for command\n```\n\n## Docker environment\n\nPull from GitHub Container registry\n\n```bash\ndocker pull ghcr.io/pinax-network/substreams-erc20-api:latest\n```\n\nBuild from source\n\n```bash\ndocker build -t substreams-erc20-api .\n```\n\nRun with `.env` file\n\n```bash\ndocker run -it --rm --env-file .env ghcr.io/pinax-network/substreams-erc20-api\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinax-network%2Fsubstreams-erc20-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinax-network%2Fsubstreams-erc20-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinax-network%2Fsubstreams-erc20-api/lists"}