Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 894 Bytes

README.md

File metadata and controls

32 lines (19 loc) · 894 Bytes

Sygma Squid Indexer

Running locally

Starting the indexer:

yarn start

Stopping and removing containers:

yarn stop

For additional commands see package.json or commands.json

Squid Indexer API

GET /transfers

Fetches transfers ordered by time. Results can be filtered by various query parameters.

Query Parameters

  • page: The page number for paginated results.
    Default: 1
  • limit: The number of records per page.
    Default: 10
  • status: The status of the transfer.
    Possible values: pending, executed, failed
  • txHash: Transaction hash of the transfer to filter by.
  • component: Component of the transfer.
    Possible values: deposit, execution
    Default: deposit
  • sender: The address of the sender to filter by.

GET /health

Health check endpoint to ensure the system is running properly