API Reference
API Reference
Explore and test HyperPaxeer APIs directly from the docs.
API Reference
Explore HyperPaxeer Network APIs interactively. This section includes GraphQL schemas for our indexer services and OpenAPI specifications for REST APIs.
GraphQL APIs
Real-time indexer data via GraphQL:
- LaunchPad GraphQL - Bonding curve markets, swaps, and token launches
- Perpetuals GraphQL - Perpetual futures positions, trades, and liquidations
- StableSwap GraphQL - Stable AMM pools, swaps, and liquidity
OpenAPI / JSON-RPC
Interactive API playgrounds for REST and RPC endpoints:
LaunchPad GraphQL
GraphQL schema for the Paxeer LaunchPad indexer.
Perpetuals GraphQL
GraphQL schema for the Paxeer Perpetuals indexer.
StableSwap GraphQL
GraphQL schema for the Paxeer StableSwap indexer.
EVM JSON-RPC
JSON-RPC API for interacting with the HyperPaxeer EVM-compatible chain.
Get info about the application. GET
Get info about the application.
Upon success, the `Cache-Control` header will be set with the default
maximum age.
Query the application for some information. GET
Query the application for some information.
Audit token metadata completeness GET
Returns detailed audit of token metadata quality including counts by type,
completeness metrics, and a sample of tokens needing enrichment.
Get block by hash GET
Get Block By Hash.
Upon success, the `Cache-Control` header will be set with the default
maximum age.
Get block results at a specified height GET
Get block_results. When the `discard_abci_responses` storage flag is
enabled, this endpoint will return an error.
If the `height` field is set to a non-default value, upon success, the
`Cache-Control` header will be set with the default maximum age.
Search for blocks by BeginBlock and EndBlock events GET
Search for blocks by BeginBlock and EndBlock events.
See /subscribe for the query syntax.
Get block at a specified height GET
Get Block.
If the `height` field is set to a non-default value, upon success, the
`Cache-Control` header will be set with the default maximum age.
Get block headers (max: 20) for minHeight <= height <= maxHeight. GET
Get block headers for minHeight <= height <= maxHeight.
At most 20 items will be returned.
Upon success, the `Cache-Control` header will be set with the default
maximum age.
Broadcast evidence of the misbehavior. GET
Broadcast evidence of the misbehavior.
Returns right away, with no response. Does not wait for CheckTx nor DeliverTx results. GET
Returns with the responses from CheckTx and DeliverTx. GET
Returns with the response from CheckTx. Does not wait for DeliverTx result. GET
Checks the transaction without executing it. GET
The transaction won't be added to the mempool.
Please refer to
https://docs.tendermint.com/v0.34/tendermint-core/using-tendermint.html#formatting
for formatting/encoding rules.
Upon success, the `Cache-Control` header will be set with the default
maximum age.
Get commit results at a specified height GET
Get Commit.
If the `height` field is set to a non-default value, upon success, the
`Cache-Control` header will be set with the default maximum age.
Get consensus parameters GET
Get consensus parameters.
If the `height` field is set to a non-default value, upon success, the
`Cache-Control` header will be set with the default maximum age.
Get consensus state GET
Get consensus state.
Not safe to call from inside the ABCI application during a block execution.
Add Peers/Persistent Peers (unsafe) GET
Set a persistent peer, this route in under unsafe, and has to manually enabled to use.
**Example:** curl 'localhost:26657/dial_peers?peers=\["f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656","0491d373a8e0fcf1023aaf18c51d6a1d0d4f31bd@5.6.7.8:26656"\]&persistent=false'
Dial Seeds (Unsafe) GET
Dial a peer, this route in under unsafe, and has to manually enabled to use
**Example:** curl 'localhost:26657/dial_seeds?seeds=\["f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656","0491d373a8e0fcf1023aaf18c51d6a1d0d4f31bd@5.6.7.8:26656"\]'
Get consensus state GET
Get consensus state.
Not safe to call from inside the ABCI application during a block execution.
Get Genesis in multiple chunks GET
Get genesis document in multiple chunks to make it easier to iterate
through larger genesis structures. Each chunk is produced by converting
the genesis document to JSON and then splitting the resulting payload
into 16MB blocks, and then Base64-encoding each block.
Upon success, the `Cache-Control` header will be set with the default
maximum age.
Get Genesis GET
Get genesis.
Upon success, the `Cache-Control` header will be set with the default
maximum age.
Get total balance with daily PnL GET
Returns the current total portfolio balance broken down by native, tokens,
and perps, plus the daily PnL compared to yesterday's snapshot.
Also saves a daily snapshot for historical tracking.
Get token holdings for a wallet GET
Returns all ERC-20 token holdings with balances, prices, and USD values.
Holdings count chart GET
Returns time-series data for the number of unique tokens held.
Get perps portfolio summary GET
Returns the complete perpetuals portfolio for a user including:
- Vault status and address
- All open positions with unrealized PnL
- Total collateral, unrealized/realized PnL
- Aggregated user stats (position counts, trade counts, orders)
Get perps positions GET
Returns perpetuals positions for a user. Can filter by status and paginate.
Each position includes market info, entry/current price, leverage, and PnL.
Get perps trade history GET
Returns perpetuals trade history for a user with pagination.
PnL chart GET
Returns time-series PnL data (change between consecutive snapshots).
Get PnL history GET
Returns daily PnL history showing portfolio value changes over time.
Each entry includes total value, component breakdown, and daily change.
Get full portfolio for a wallet GET
Returns the complete portfolio for a wallet address including:
- Native PAX balance with USD value
- All ERC-20 token holdings with prices
- Perpetuals portfolio summary (vault, positions, PnL)
- Total portfolio value in USD
Portfolio value chart GET
Returns time-series data for portfolio total value.
Uses high-frequency snapshots (5min intervals) when available, falls back to daily.
**Granularity by period:**
- `1d` → every 5 min
- `7d` → every 1 hour
- `30d` → every 4 hours
- `90d` → every day
- `1y` → every day
Get single token metadata GET
Returns metadata for a specific token by its contract address.
Get transactions for a wallet GET
Returns enriched transaction history with type classification,
token transfer details, gas costs, and USD values. Supports pagination.
Transaction volume chart GET
Returns time-series data for transaction volume in USD.
Node heartbeat GET
Get node health. Returns empty result (200 OK) on success, no response - in case of an error.
Service health check GET
Returns service status and version. Use for uptime monitoring and readiness probes.
List all tokens (summary) GET
Returns a summary of all tracked tokens with metadata completeness stats.
Network informations GET
Get network info.
Get data about unconfirmed transactions GET
Get data about unconfirmed transactions
Node Status GET
Get Tendermint status including node info, pubkey, latest block hash, app hash, block height and time.
Subscribe for events via WebSocket. GET
NOTE: if you're not reading events fast enough, Tendermint might
terminate the subscription.
Trigger price sync from all DB sources POST
Manually triggers a full price sync from:
- **Price Oracle DB**: PAX native price (candle close)
- **DEX Subgraph DB**: All DEX market spot prices
- **Hardcoded**: Stablecoin prices fixed at $1.00
Prices are stored in the Portfolio DB and used for portfolio valuations.
This runs automatically every 30 seconds.
Trigger token metadata sync from Paxscan POST
Manually triggers a full sync of token metadata from the Paxscan block explorer database.
This runs automatically every 5 minutes but can be triggered on-demand.
Search for transactions GET
Search for transactions w/ their results.
See /subscribe for the query syntax.
Get transactions by hash GET
Get a transaction
Upon success, the `Cache-Control` header will be set with the default
maximum age.
Get the list of unconfirmed transactions GET
Get list of unconfirmed transactions
Unsubscribe from all events via WebSocket GET
Unsubscribe from all events via WebSocket
Unsubscribe from event on Websocket GET
Get validator set at a specified height GET
Get Validators. Validators are sorted by voting power.
If the `height` field is set to a non-default value, upon success, the
`Cache-Control` header will be set with the default maximum age.
How is this guide?
Last updated on