Skip to main content

Documentation Index

Fetch the complete documentation index at: https://beta.docs.sqd.dev/llms.txt

Use this file to discover all available pages before exploring further.

  1. POST your data request to /stream or /finalized-stream and you shall receive a JSON lines stream: 
    curl https://portal.sqd.dev/datasets/solana-mainnet/stream \
  -X POST \
  -d '{
    "type": "solana",
    "fromBlock": 325000000,
    "toBlock": 325000001,
    "fields": {
      "block": {"number": true},
      "instruction": {"data": true}
    },
    "instructions": [
      {"programId": [
        "MoonCVVNZFSYkqNXP6bxHLPL6QQJiMagDL3qcqUQTrG"
      ]}
    ]
  }'
    outputs 
    {"header":{"number":325000000},"instructions":[{"data":"XJqfG9ATWCDLLmxbNnKxcQ6KRHveSXFyrM8JwmyievueP"}]}
{"header":{"number":325000001}}
  2. By default the Portal will only include blocks with data matching the request filters. However, the stream will always include the first and the last blocks of the block range it covered, even if they have no matching data.
  3. The portal may end stream before it reaches toBlock. You can omit toBlock for open-ended streaming.
  4. To get the rest of the data, the client must adjust the fromBlock field to the number of the last received block plus one. When streaming unfinalized data from /stream, they must also include parentBlockHash into the request.

​
Handling forks on /stream

  1. Chain forks / reorgs sometimes make some of the data from /stream obsolete. The portal will detect that using the parentBlockHash field of the request and respond with an HTTP 409 containing a sample of new consensus blocks. When that happens, the client must roll back any changes to its own state made due to orphan blocks’ data, then send another POST /stream that starts from an earlier block to attempt to fetch the updated chain.
  2. Post-rollback request must contain parentBlockHash. If the Portal detects that the block is still not in the updated chain, it’ll return a 409 again. Be prepared to process several of these in a row.
  3. To make state management easier for the client, Portal may return X-Sqd-Finalized-Head-Number and X-Sqd-Finalized-Head-Hash headers with each response from /stream. The block from these headers and blocks below it won’t ever reorganize.
  4. That doesn’t mean that X-Sqd-Finalized-Head-Number is a non-decreasing value: Portals can be behind load balancers and the value may decrease when the load balancer switches to a lagging instance. The client should trust the guarantees provided by either instance and treat the highest block returned with these headers as a high water mark for finalized blocks.