From 8ad10a41cc90b0549b7b1df184ec6441868682f5 Mon Sep 17 00:00:00 2001 From: Etienne Donneger Date: Wed, 21 Aug 2024 00:28:41 +0000 Subject: [PATCH] Add additional notes for GraphQL endpoint usage (#66) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 1acfb21..85ff669 100644 --- a/README.md +++ b/README.md @@ -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.