API

Railnet indexes its contracts and exposes the indexed state as a read-only GraphQL API. Use it to display balances, track deposits and redeems through the STEAM lifecycle, and build dashboards without running your own indexer.

Endpoint

https://graphql-enriched.staging.railnet.org/query

The API is read-only and currently unauthenticated — send a GraphQL query as an HTTP POST.

This is the staging endpoint. The production endpoint will be provided when available.

Open in Apollo Sandbox

Run these queries against the live endpoint in your browser — with schema autocomplete and docs.

Query conventions

The API follows Hasura’s argument and filter grammar, not the subgraph conventions used by The Graph.

Root fields

Each entity gets two root fields, named exactly like the entity type in PascalCase — Vehicle, Query, Conduit. There is no pluralized or camelCase alias.

Root field	Returns	Arguments
`Vehicle`	list of matching rows	`where`, `order_by`, `limit`, `offset`, `distinct_on`
`Vehicle_by_pk`	a single row or `null`	`id`

GraphQL

query Roots($id: String!) {
  Vehicle(where: { enabled: { _eq: true } }, order_by: { name: asc }, limit: 10) {
    address
    name
  }

  Vehicle_by_pk(id: $id) {
    address
    name
  }
}

Entity IDs are deterministic and chain-scoped (for example 8453_contract_0x6eea217d…). Prefer filtering on address or owner over reconstructing an ID.

Filtering

where accepts one input object per entity, with a key per scalar field, per relationship, and the boolean combinators _and, _or, _not.

Operator	Applies to	Notes
`_eq`, `_neq`	all types	exact match
`_in`, `_nin`	all types	list membership
`_gt`, `_gte`, `_lt`, `_lte`	all types	numeric and lexicographic ordering
`_is_null`	all types	`true` / `false`
`_like`, `_ilike`, `_nlike`, `_nilike`	`String` only	SQL pattern match, case-insensitive in the `_i` variants

Addresses are stored lowercase. Filter them with _ilike so a checksummed address from a wallet or block explorer still matches: where: { address: { _ilike: $address } }.

Relationships are filterable, so you can select through the graph instead of chaining round-trips:

GraphQL

query OpenRedeems($strategy: String!) {
  Query(
    where: {
      vehicle: { address: { _ilike: $strategy } }
      mode: { _eq: "REDEEM" }
      _not: { state: { _in: ["SETTLED", "REJECTED"] } }
    }
  ) {
    id
    state
    owner
  }
}

Sorting and pagination

order_by takes an object (or a list of objects for multi-key sorts) with asc or desc, and nested relationships are sortable. limit and offset work as expected; for large result sets, prefer passing the last id you saw as a cursor.

GraphQL

query VehiclePage($cursor: String!) {
  Vehicle(where: { id: { _gt: $cursor } }, order_by: { id: asc }, limit: 100) {
    id
    address
    name
  }
}

Value types

Kind	Wire type	Representation
addresses and byte strings	`String`	lowercase `0x`-prefixed hex
token and share amounts	`numeric`	decimal string — `"3000000"`, never a JSON number
prices and rates	`numeric`	decimal string — `"0.9996709120638021"`
enums (`mode`, `state`, …)	lowercase scalar	uppercase string — `"DEPOSIT"`, `"SETTLED"`

GraphQL

query ByState($states: [state!], $mode: mode!) {
  Query(where: { state: { _in: $states }, mode: { _eq: $mode } }) {
    id
  }
}

Variables

{ "states": ["PROCESSING", "UNLOCKING"], "mode": "DEPOSIT" }

Core entities

These are the entities you need for balances, product state, and operation tracking. The schema covers considerably more — engines, queues, roles, fees, and automation — which you can explore through introspection.

Vehicle

Every yield source and strategy is a Vehicle row.

Field	Type	Notes
`address`	`String`	vehicle contract
`name`, `symbol`	`String`	ERC-20 metadata
`vehicleType`	`vehicletype`	discriminator string, e.g. `"MULTI_VEHICLE"`
`asset`	`String`	base asset address
`assetDecimals`	`Int`	decimals of `asset`
`assetSymbol`	`String`	resolved symbol of `asset`, nullable
`assetPriceUSD`	`numeric`	latest indexed price, nullable
`supply`	`numeric`	share supply, always 18 decimals
`enabled`	`Boolean`	accepting queries
`weeklyYield`, `monthlyYield`, `inceptionYield`	`Yield`	`netApr` and `netApy` in percentage points (`4.25` = 4.25%), nullable until enough history exists
`queries`	`[Query]`	every query against this vehicle
`balances`	`[Balance]`	share balance per holder

Query

One row per STEAM query — the unit of every deposit and redeem. id is the on-chain query id.

Field	Type	Notes
`mode`	`mode`	`DEPOSIT` or `REDEEM`
`state`	`state`	`EMPTY`, `PROCESSING`, `PAUSED`, `UNLOCKING`, `RECOVERING`, `REJECTED`, or `SETTLED`
`owner`	`String`	account that opened the query
`receiver`	`String`	account that receives the output
`input`	`[AssetInput]`	assets committed on creation — `address` and `value` per asset
`output`	`[AssetOutput]`	assets owed on settlement — `address` and `value` per asset
`vehicle`	`Vehicle`	vehicle the query targets

state is updated in place, so the row always reflects the current state. SETTLED and REJECTED are terminal — treat everything else as in-flight. See the STEAM standard for the state machine.

Balance

Share balance of one holder in one vehicle: owner, value (18 decimals), vehicle.

Conduit

A distribution channel wrapping a vehicle with its own ERC-20 share token.

Field	Type	Notes
`address`	`String`	conduit contract
`name`, `symbol`	`String`	branded ERC-20 metadata
`asset`, `assetDecimals`, `assetSymbol`, `assetPriceUSD`	—	underlying asset, same semantics as on `Vehicle`
`supply`	`numeric`	conduit share supply
`enabled`, `transferEnabled`	`Boolean`	open for deposits / share transfers
`vehicle`	`Vehicle`	wrapped strategy
`weeklyYield`, `monthlyYield`, `inceptionYield`	`Yield`	same semantics as on `Vehicle`
`queries`	`[ConduitQuery]`	deposits and redeems through this conduit
`balances`	`[ConduitBalance]`	share balance per holder

ConduitQuery and ConduitBalance

Entity	Fields
`ConduitQuery`	`owner`, `conduit`, `query` → the underlying STEAM `Query`
`ConduitBalance`	`owner`, `value`, `conduit`

Example queries

Vehicle overview

GraphQL

query VehicleOverview($address: String!) {
  Vehicle(where: { address: { _ilike: $address } }) {
    address
    name
    symbol
    vehicleType
    asset
    assetSymbol
    assetDecimals
    assetPriceUSD
    supply
    enabled
    inceptionYield {
      netApr
      netApy
    }
  }
}

Conduit overview

GraphQL

query ConduitOverview($address: String!) {
  Conduit(where: { address: { _ilike: $address } }) {
    address
    name
    symbol
    asset
    assetSymbol
    assetDecimals
    supply
    enabled
    transferEnabled
    vehicle {
      address
      name
      vehicleType
    }
    inceptionYield {
      netApr
      netApy
    }
  }
}

Holder position across vehicles and conduits

GraphQL

query HolderPosition($owner: String!) {
  Balance(where: { owner: { _ilike: $owner }, value: { _gt: 0 } }) {
    value
    vehicle {
      address
      symbol
      assetSymbol
      assetDecimals
    }
  }
  ConduitBalance(where: { owner: { _ilike: $owner }, value: { _gt: 0 } }) {
    value
    conduit {
      address
      symbol
      assetSymbol
      assetDecimals
    }
  }
}

One query’s current state

GraphQL

query QueryState($id: String!) {
  Query_by_pk(id: $id) {
    id
    mode
    state
    owner
    receiver
    vehicle {
      address
      name
      assetDecimals
    }
    input {
      address
      value
    }
    output {
      address
      value
    }
    event {
      tx {
        hash
        block {
          number
          timestamp
        }
      }
    }
  }
}

In-flight queries for a vehicle

GraphQL

query OpenQueries($address: String!, $states: [state!]) {
  Query(
    where: {
      vehicle: { address: { _ilike: $address } }
      state: { _in: $states }
    }
    order_by: { event: { tx: { block: { number: desc } } } }
    limit: 50
  ) {
    id
    mode
    state
    owner
    input {
      address
      value
    }
  }
}

Variables

{
  "address": "0x6eea217dd6bdd3bcb4db0f20a846d66afd00963e",
  "states": ["PROCESSING", "PAUSED", "UNLOCKING", "RECOVERING"]
}

Indexer health

Check sync progress before trusting a result as current.

GraphQL

query IndexerHealth {
  _meta {
    chainId
    isReady
    progressBlock
    sourceBlock
    readyAt
  }
}

sourceBlock - progressBlock is the indexing lag in blocks. isReady: false means the indexer is still backfilling and rows are incomplete.

Explore the schema

The endpoint has introspection enabled, so any GraphQL client can discover entities and fields beyond the core set above. It does not serve a browser playground itself — use the Apollo Sandbox link for that.

GraphQL

{
  __type(name: "Vehicle") {
    fields {
      name
      type {
        kind
        name
        ofType {
          name
        }
      }
    }
  }
}

Next steps

Integrate a Conduit

Combine on-chain calls with indexed data to build an earn experience.

STEAM standard

The state machine behind Query.state and Query.mode.

Getting started

How-to guides

Reference

Endpoint

Open in Apollo Sandbox

Query conventions

Root fields

Filtering

Value types

Core entities

Vehicle

Query

Balance

Conduit

ConduitQuery and ConduitBalance

Example queries

Vehicle overview

Conduit overview

Holder position across vehicles and conduits

One query’s current state

In-flight queries for a vehicle

Indexer health

Explore the schema

Next steps

Integrate a Conduit

STEAM standard

​Endpoint

Open in Apollo Sandbox

​Query conventions

​Root fields

​Filtering

​Sorting and pagination

​Value types

​Core entities

​Vehicle

​Query

​Balance

​Conduit

​ConduitQuery and ConduitBalance

​Example queries

​Vehicle overview

​Conduit overview

​Holder position across vehicles and conduits

​One query’s current state

​In-flight queries for a vehicle

​Indexer health

​Explore the schema

​Next steps

Integrate a Conduit

STEAM standard

Endpoint

Query conventions

Root fields

Filtering

Sorting and pagination

Value types

Core entities

Vehicle

Query

Balance

Conduit

ConduitQuery and ConduitBalance

Example queries

Vehicle overview

Conduit overview

Holder position across vehicles and conduits

One query’s current state

In-flight queries for a vehicle

Indexer health

Explore the schema

Next steps