curl --request GET \
--url https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": [
{
"snapshot_ts": "2023-11-07T05:31:56Z",
"symbol": "BTC",
"coin": "BTC",
"long_count": 18234,
"short_count": 15102,
"long_size": "8123.45",
"short_size": "8120.1",
"long_value": "528000000.5",
"short_value": "527800000.25",
"long_avg_entry_price": "63120.4",
"short_avg_entry_price": "66210.9",
"long_positions_with_entry": 18230,
"short_positions_with_entry": 15100,
"long_top10_value_share": "0.412345",
"short_top10_value_share": "0.385",
"top10_value_share": "0.301",
"quality": "complete",
"dex": "xyz"
}
],
"meta": {
"count": 123,
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_cursor": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"snapshot_ts": "2023-11-07T05:31:56Z",
"source": "snapshot",
"quality": "<string>",
"stale": true,
"built_through": "2023-11-07T05:31:56Z",
"finalized_through": "2023-11-07T05:31:56Z",
"requested_end": "2023-11-07T05:31:56Z",
"clamped_to": "2023-11-07T05:31:56Z",
"totals": {
"snapshot_ts": "2023-11-07T05:31:56Z",
"symbol": "BTC",
"coin": "BTC",
"long_count": 18234,
"short_count": 15102,
"long_size": "8123.45",
"short_size": "8120.1",
"long_value": "528000000.5",
"short_value": "527800000.25",
"long_avg_entry_price": "63120.4",
"short_avg_entry_price": "66210.9",
"long_positions_with_entry": 18230,
"short_positions_with_entry": 15100,
"long_top10_value_share": "0.412345",
"short_top10_value_share": "0.385",
"top10_value_share": "0.301",
"quality": "complete",
"dex": "xyz"
},
"coverage_from": "2023-11-07T05:31:56Z",
"notice": "<string>"
}
}{
"code": 400,
"error": "Failed to deserialize query string: limit: invalid digit found in string",
"error_code": "invalid_query_params",
"request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}{
"code": 404,
"error": "Resource not found"
}{
"code": 429,
"error": "Rate limit exceeded"
}{
"code": 503,
"error": "Account positions are not available right now.",
"error_code": "positions_unavailable"
}Get HIP-3 market positions summary
0xArchive API reference for Get HIP-3 market positions summary. Includes route metadata, schemas, examples, and implementation notes.
curl --request GET \
--url https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.0xarchive.io/v1/hyperliquid/hip3/positions/{symbol}/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": [
{
"snapshot_ts": "2023-11-07T05:31:56Z",
"symbol": "BTC",
"coin": "BTC",
"long_count": 18234,
"short_count": 15102,
"long_size": "8123.45",
"short_size": "8120.1",
"long_value": "528000000.5",
"short_value": "527800000.25",
"long_avg_entry_price": "63120.4",
"short_avg_entry_price": "66210.9",
"long_positions_with_entry": 18230,
"short_positions_with_entry": 15100,
"long_top10_value_share": "0.412345",
"short_top10_value_share": "0.385",
"top10_value_share": "0.301",
"quality": "complete",
"dex": "xyz"
}
],
"meta": {
"count": 123,
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_cursor": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"snapshot_ts": "2023-11-07T05:31:56Z",
"source": "snapshot",
"quality": "<string>",
"stale": true,
"built_through": "2023-11-07T05:31:56Z",
"finalized_through": "2023-11-07T05:31:56Z",
"requested_end": "2023-11-07T05:31:56Z",
"clamped_to": "2023-11-07T05:31:56Z",
"totals": {
"snapshot_ts": "2023-11-07T05:31:56Z",
"symbol": "BTC",
"coin": "BTC",
"long_count": 18234,
"short_count": 15102,
"long_size": "8123.45",
"short_size": "8120.1",
"long_value": "528000000.5",
"short_value": "527800000.25",
"long_avg_entry_price": "63120.4",
"short_avg_entry_price": "66210.9",
"long_positions_with_entry": 18230,
"short_positions_with_entry": 15100,
"long_top10_value_share": "0.412345",
"short_top10_value_share": "0.385",
"top10_value_share": "0.301",
"quality": "complete",
"dex": "xyz"
},
"coverage_from": "2023-11-07T05:31:56Z",
"notice": "<string>"
}
}{
"code": 400,
"error": "Failed to deserialize query string: limit: invalid digit found in string",
"error_code": "invalid_query_params",
"request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}{
"code": 404,
"error": "Resource not found"
}{
"code": 429,
"error": "Rate limit exceeded"
}{
"code": 503,
"error": "Account positions are not available right now.",
"error_code": "positions_unavailable"
}X-API-Key with this request. See REST authentication.Shared request rules
Shared request rules
Machine schema
Machine schema
Authorizations
API key for authentication. Get yours at https://0xarchive.io/dashboard
Path Parameters
HIP-3 symbol in dex:COIN form (e.g. xyz:TSLA).
"xyz:TSLA"
Query Parameters
Inclusive start in Unix milliseconds. Defaults to 24 hours before end.
Exclusive end in Unix milliseconds. Defaults to now.
Maximum rows per page (default 100, max 2000).
1 <= x <= 2000Cursor from the previous response meta.next_cursor. Keep every other parameter unchanged.
Response
Get HIP-3 market positions summary
Market long/short aggregates: one point now, or one per hour.
true
Hide child attributes
Hide child attributes
Snapshot the aggregates describe.
"BTC"
Alias of symbol.
"BTC"
18234
15102
Total long size in base units.
"8123.45"
Total short size in base units.
"8120.1"
Total long value in USD. Null when any long position has no mark.
"528000000.5"
Total short value in USD. Null when any short position has no mark.
"527800000.25"
Size-weighted average entry of long positions with a known entry.
"63120.4"
Size-weighted average entry of short positions with a known entry.
"66210.9"
18230
15100
Share of long value held by the ten largest long positions.
"0.412345"
Share of short value held by the ten largest short positions.
"0.385"
Share of total value held by the ten largest positions.
"0.301"
complete, partial, or degraded, from this market's own rows.
"complete"
HIP-3 only.
"xyz"
Response metadata of the account positions routes. Every instant is RFC 3339 UTC with milliseconds and comes from the data, never the request time.
Hide child attributes
Hide child attributes
Number of records returned.
Unique request ID for support.
Signed cursor for the next page, bound to the request. Pass it back with the same parameters. A market cursor pins its snapshot; if that snapshot is replaced or expires the next page answers 409 snapshot_advanced.
Instant the returned state describes: the snapshot tick or hour, or the requested as-of time.
Committed snapshot the response was read from. Market routes echo the resolved hour here.
How the rows were produced: snapshot (live or hourly snapshot), reconstructed (as-of state between snapshots), or changes (change log).
snapshot, reconstructed, changes Completeness of the snapshot the response was read from: complete, partial, or degraded. Rows carry their own quality. On Lighter and Robinhood Chain, snapshots from the latest day, before the venue's daily trade reconcile, can read degraded while their rows read preliminary; they read complete once the reconcile has run.
True on current reads when the latest snapshot is older than 12 minutes; paired with notice.
Every event before this instant is built into the change log and as-of state. Reads are clamped to it.
Every event before this instant is final and will not be re-derived (Lighter: the trade finalization watermark). Never later than built_through.
The end or timestamp the caller asked for, echoed when the read was clamped.
Boundary the read was clamped to (built_through). Present only when clamped.
Market listings, first page only: aggregates over the whole filtered result set, not just this page.
Hide child attributes
Hide child attributes
Snapshot the aggregates describe.
"BTC"
Alias of symbol.
"BTC"
18234
15102
Total long size in base units.
"8123.45"
Total short size in base units.
"8120.1"
Total long value in USD. Null when any long position has no mark.
"528000000.5"
Total short value in USD. Null when any short position has no mark.
"527800000.25"
Size-weighted average entry of long positions with a known entry.
"63120.4"
Size-weighted average entry of short positions with a known entry.
"66210.9"
18230
15100
Share of long value held by the ten largest long positions.
"0.412345"
Share of short value held by the ten largest short positions.
"0.385"
Share of total value held by the ten largest positions.
"0.301"
complete, partial, or degraded, from this market's own rows.
"complete"
HIP-3 only.
"xyz"
Coverage start, present with notice when the request falls before coverage or the address has no recorded activity.
Human-readable advisory: before coverage, no recorded activity, or a stale snapshot.
Was this page helpful?