Skip to content

Commit

Permalink
Add additional notes for GraphQL endpoint usage (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
0237h authored Aug 21, 2024
1 parent 78b89a8 commit 8ad10a4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@

Go to `/graphql` for a GraphIQL interface.

### Additional notes

- For the `block_range` parameter in `transfers`, you can pass a single integer value (low bound) or an array of two values (inclusive range).
- If you input the same account in the `from` and `to` field for transfers, you'll get all inbound and outbound transfers for that account.
- The more parameters you add (i.e. the more precise your query is), the faster it should be for the back-end to fetch it.
- Don't forget to request for the `meta` fields in the response to get access to pagination and statistics !

## Requirements

- [ClickHouse](clickhouse.com/), databases should follow a `{chain}_tokens_{version}` naming scheme. Database tables can be setup using the [`schema.sql`](./schema.sql) definitions created by the [`create_schema.sh`](./create_schema.sh) script.
Expand Down

0 comments on commit 8ad10a4

Please sign in to comment.