Starknet Subsquid Network API

warning

The Starknet API of Subsquid Network is currently in beta. Breaking changes may be introduced in the future releases.

Subsquid Network API distributes the requests over a (potentially decentralized) network of workers. The main gateway URL points at a router that provides URLs of workers that do the heavy lifting. Each worker has its own range of blocks on each dataset it serves.

Suppose you want to retrieve an output of some query on a block range starting at firstBlock (can be the genesis block) and ending at the highest available block. Proceed as follows:

Retrieve the dataset height from the router with GET /height and make sure it's above firstBlock.
Save the value of firstBlock to some variable, say currentBlock.
Query the router for an URL of a worker that has the data for currentBlock with GET /${currentBlock}/worker.
Retrieve the data from the worker by posting the query (POST /), setting the "fromBlock" query field to ${currentBlock}.
Parse the retrieved data to get a batch of query data plus the height of the last block available from the current worker. Take the header.number field of the last element of the retrieved JSON array - it is the height you want. Even if your query returns no data, you'll still get the block data for the last block in the range, so this procedure is safe.
Set currentBlock to the height from the previous step plus one.
Repeat steps 3-6 until all the required data is retrieved.

The main URL of the Starknet gateway is

https://v2.archive.subsquid.io/network/starknet-mainnet

warning

Unlike in the explorer, addresses in this API do not have leading zeros (both in valid requests and in the returned data). For example, explorer's 0x00ce6c...0552 becomes 0xce6c...0552. This is the format that Starknet RPC nodes use.

Implementation examples:

Manually with cURL

Suppose we want data on all txs sent by Layerswap/0x19252b1deef483477c4d30cfcc3e5ed9c82fafea44669c182a45a01b4fdb97a starting from block 600_000. The steps are:

Verify that the dataset has reached the required height:

curl https://v2.archive.subsquid.io/network/starknet-mainnet/height

Output

Remember that your current height is 600000.

Get a worker URL for the current height:

curl https://v2.archive.subsquid.io/network/starknet-mainnet/600000/worker

Output

https://rb03.sqd-archive.net/worker/query/czM6Ly9zdGFya25ldC1tYWlubmV0

Retrieve the data from the current worker

curl https://rb03.sqd-archive.net/worker/query/czM6Ly9zdGFya25ldC1tYWlubmV0 \
-X 'POST' -H 'content-type: application/json' -H 'accept: application/json' \
-d '{
    "type": "starknet",
    "fromBlock":600000,
    "toBlock":632494,
    "fields":{"transaction":{"transactionHash":true}},
    "transactions":[{"senderAddress":["0x19252b1deef483477c4d30cfcc3e5ed9c82fafea44669c182a45a01b4fdb97a"]}]
}' | jq

Output:

[
  {
    "header": {
      "number": 600000,
      "hash": "0x898fe7f61f5d662199d223de496988f221d150ed054f2fe5e681b2988b9e2c"
    },
    "transactions": []
  },
  {
    "header": {
      "number": 600007,
      "hash": "0x44aa251cee1baaf3f19accefd223ce5208815686c881bf645ffb3e3348a5ddc"
    },
    "transactions": [
      {
        "transactionIndex": 24,
        "transactionHash": "0x6a88edb0713769de4ad4d450df70911c3e9a7e8253c135c9574d0b3542ced18"
      }
    ]
  },
  ...
  {
    "header": {
      "number": 617979,
      "hash": "0x7f6a8516a91eefa6a65972c47002cbe3851e3c4287f670c914850960d29ca29"
    },
    "transactions": []
  }
]

Parse the retrieved data:
- Grab the network data you requested from the list items with non-empty data fields (transactions, events). For the example above, this data will include the txn 0x6a88....
- Observe that we received the data up to and including block 617979.
To get the rest of the data, update the current height to 617980 and go to step 3.
- Note how the worker URL you're getting while repeating step 3 points to a different host than before. This is how data storage and reads are distributed across the Subsquid Network.
Repeat steps 3 through 6 until the dataset height of 632494 is reached.

In Python

def get_text(url: str) -> str:
    res = requests.get(url)
    res.raise_for_status()
    return res.text

def dump(
    gateway_url: str,
    query: Query,
    first_block: int,
    last_block: int
) -> None:
    assert 0 <= first_block <= last_block
    query = dict(query)  # copy query to mess with it later

    dataset_height = int(get_text(f'{gateway_url}/height'))
    next_block = first_block
    last_block = min(last_block, dataset_height)

    while next_block <= last_block:
        worker_url = get_text(f'{gateway_url}/{next_block}/worker')

        query['fromBlock'] = next_block
        query['toBlock'] = last_block
        res = requests.post(worker_url, json=query)
        res.raise_for_status()
        blocks = res.json()

        last_processed_block = blocks[-1]['header']['number']
        next_block = last_processed_block + 1
        for block in blocks:
            print(json.dumps(block))

Full code here.

Router API

GET /height (get height of the dataset)

Example response: 632494.

GET ${firstBlock}/worker (get a suitable worker URL)

The returned worker is capable of processing POST / requests in which the "fromBlock" field is equal to ${firstBlock}.

Example response: https://rb06.sqd-archive.net/worker/query/czM6Ly9zdGFya25ldC1tYWlubmV0.

Worker API

POST / (query transactions and events)

Query Fields

type: "starknet".
fromBlock: Block number to start from (inclusive).
toBlock: (optional) Block number to end on (inclusive). If this is not given, the query will go on for a fixed amount of time or until it reaches the height of the dataset.
includeAllBlocks: (optional) If true, the Network will include blocks that contain no data selected by data requests into its response.
fields: (optional) A selector of data fields to retrieve. Common for all data items.
transactions: (optional) A list of transaction requests. An empty list requests no data.
events: (optional) A list of event requests. An empty list requests no data.

The response is a JSON array of per-block data items that covers a block range starting from fromBlock. The last block of the range is determined by the worker. You can find it by looking at the header.number field of the last element in the response array.

The first and the last block in the range are returned even if all data requests return no data for the range.

In most cases the returned range will not contain all the range requested by the user (i.e. the last block of the range will not be toBlock). To continue, retrieve a new worker URL for blocks starting at the end of the current range plus one block and repeat the query with an updated value of fromBlock.

Example Request

{
  "type": "starknet",
  "fromBlock":632000,
  "toBlock":632494,
  "fields": {
    "block": {
      "timestamp": true
    },
    "event": {
      "keys": true,
      "data": true
    },
    "transaction": {
      "transactionHash":true
    }
  },
  "events": [
    {
      "fromAddress": [
        "0x19252b1deef483477c4d30cfcc3e5ed9c82fafea44669c182a45a01b4fdb97a"
      ],
      "transaction": true
    }
  ]
}

Example Response

[
  {
    "header": {
      "number": 632000,
      "hash": "0xdfebe2b6af20dfe7f27d5fe8b1b4e8ee48ad812ce9bfd9c756c9db7dbcdb22",
      "timestamp": 1712950160
    },
    "transactions": [
      {
        "transactionIndex": 110,
        "transactionHash": "0x151fa3c8633e6ed71301af4afc8f73a141ef39cca1d51d0f72d66a11911e2f3"
      },
      {
        "transactionIndex": 306,
        "transactionHash": "0x7e1c307624c5c78e311e2a08f0355dfef80e6fc6ed47c64ceda757e044f2c85"
      }
    ],
    "events": [
      {
        "transactionIndex": 110,
        "eventIndex": 1,
        "keys": [
          "0x1dcde06aabdbca2f80aa51392b345d7549d7757aa855f7e37f5d335ac8243b1",
          "0x151fa3c8633e6ed71301af4afc8f73a141ef39cca1d51d0f72d66a11911e2f3"
        ],
        "data": [
          "0x1",
          "0x1",
          "0x1"
        ]
      },
      {
        "transactionIndex": 306,
        "eventIndex": 1,
        "keys": [
          "0x1dcde06aabdbca2f80aa51392b345d7549d7757aa855f7e37f5d335ac8243b1",
          "0x7e1c307624c5c78e311e2a08f0355dfef80e6fc6ed47c64ceda757e044f2c85"
        ],
        "data": [
          "0x1",
          "0x1",
          "0x1"
        ]
      }
    ]
  },
  ...
  {
    "header": {
      "number": 632492,
      "hash": "0x440ee029f2a970b2546eb39ab23075659ec8e0246c94f62d21e21f912dfb58d",
      "timestamp": 1713049189
    },
    "transactions": [
      {
        "transactionIndex": 125,
        "transactionHash": "0x61bd3d233cfe9cb387f3b016127ffb0d66d265c2593f80a317404e2f3c334bb"
      }
    ],
    "events": [
      {
        "transactionIndex": 125,
        "eventIndex": 1,
        "keys": [
          "0x1dcde06aabdbca2f80aa51392b345d7549d7757aa855f7e37f5d335ac8243b1",
          "0x61bd3d233cfe9cb387f3b016127ffb0d66d265c2593f80a317404e2f3c334bb"
        ],
        "data": [
          "0x1",
          "0x1",
          "0x1"
        ]
      }
    ]
  },
  {
    "header": {
      "number": 632494,
      "hash": "0x2782c5ca3f1d3eb2e4c085fc17908b9b86bfe91807cd452374bcb40b2245925",
      "timestamp": 1713049569
    },
    "transactions": [],
    "events": []
  }
]

Data requests

Transactions

{
  contractAddress: string[],
  senderAddress: string[],
  type: string[],
  firstNonce: int,
  lastNonce: int,
  events: boolean
}

A transaction will be included in the response if it matches all the requests. An empty array matches no transactions; omit all requests to match all transactions.

All events emitted by the selected transactions will be included into the response if events is set to true.

See Data fields selector for info on field selection.

Events

{
  fromAddress: string[],
  key0: string[],
  key1: string[],
  key2: string[],
  key3: string[],
  transaction: boolean
}

An event will be included in the response if it matches all the requests. An empty array matches no events; omit all requests to match all events.

If transaction is set to true, all parent transactions will be included into the response.

See Data fields selector for info on field selection.

Data fields selector

A selector of fields for the returned data items. Its structure is as follows:

{
  block:               // field selector for blocks
  transaction:         // field selector for transactions
  event:               // field selector for events
}

Block fields

{
  parentHash
  status
  newRoot
  timestamp
  sequencerAddress
}

A valid field selector for blocks is a JSON that has a subset of these fields as keys and true as values, e.g. {"status": true, "timestamp": true}.

Transaction fields

{
  transactionHash
  contractAddress
  entryPointSelector
  calldata
  maxFee
  type
  senderAddress
  version
  signature
  nonce
  classHash
  compiledClassHash
  contractAddressSalt
  constructorCalldata
}

A valid field selector for transactions is a JSON that has a subset of these fields as keys and true as values, e.g. {"transactionHash": true, "type": true, "calldata": true}.

Event fields

{
  fromAddress
  keys
  data
}

A valid field selector for logs is a JSON that has a subset of these fields as keys and true as values, e.g. {"fromAddress": true, "data": true}.

Starknet Subsquid Network API

Router API​

Worker API​

Query Fields​

Example Request​

Example Response​

Data requests​

Transactions​

Events​

Data fields selector​

Block fields​

Transaction fields​

Event fields​