> ## Documentation Index > Fetch the complete documentation index at: https://docs.ironflow.sh/llms.txt > Use this file to discover all available pages before exploring further. # Hyperliquid net deposit and withdrawal flows > GET /v1/analytics/net-flows returns Hyperliquid deposits minus withdrawals per time bucket, showing capital moving in and out. Builder tier or above required. ## OpenAPI ````yaml GET /v1/analytics/net-flows openapi: 3.1.0 info: title: Ironflow API version: 1.0.0 description: > Hyperliquid market data from Ironflow's own nodes: tick-level fills and trades, candles, funding rates, liquidations, mark prices, open interest, markets and wallet analytics over REST. One schema across native HL perps, HIP-3 builder markets, HIP-4 outcome contracts and HL spot. **Base URL:** `https://api.ironflow.sh` **Authentication:** Read endpoints work without a key (keyless access) or with a Bearer token in the `Authorization` header. Writes always need a key. ``` Authorization: Bearer if_your_api_key ``` Get a free key at https://ironflow.sh/key. **Access levels:** | Access | Requests per minute | History | Max range per request | |---|---|---|---| | No key | 10 per IP | 24 hours | 1 hour | | Free key | 60 | 30 days | 6 hours | | Explorer | 100 | 90 days | 24 hours | | Builder | 1,000 | 1 year | 7 days | | Enterprise | 10,000 | full | unlimited | Without a market filter, high-volume endpoints allow at most 4 hours per request. A header that is present but malformed returns 401; keyless access applies only when no `Authorization` header is sent. **Data availability:** fills and trades cover a rolling 12 months; other datasets start later (funding 2025-09-27, open interest and mark prices 2026-04-29). **Timestamps:** All timestamps are Unix milliseconds (int64). **Pagination:** Paginated endpoints return a `cursor` in `pagination.next_cursor`. Pass it as the `cursor` query parameter to fetch the next page. When `pagination.has_more` is `false`, you have reached the last page. contact: name: Ironflow Support url: https://ironflow.sh servers: - url: https://api.ironflow.sh description: Production security: - bearerAuth: [] - {} tags: - name: Market Data description: Historical tick-level market data stored in ClickHouse. - name: Analytics description: Aggregated analytics endpoints (Builder tier and above). - name: Cohorts description: Predefined and custom address groups for filtering market data. - name: Info Proxy description: >- Cached passthrough to the Hyperliquid Info API. No record caps, higher rate limits. - name: Export description: Bulk data export as CSV or Parquet (Builder tier and above). - name: Query description: >- Read-only ClickHouse SQL over curated Hyperliquid tables (hl.*), limited by tier. - name: System description: Health checks and metadata endpoints. - name: TradingApp description: >- Trading app Phase A — wallet auth (SIWE), agent-key provisioning, and kill-switch. paths: /v1/analytics/net-flows: get: tags: - Analytics summary: Net deposit/withdrawal flows description: | Aggregated deposits minus withdrawals over time intervals. Shows capital inflows and outflows. **Builder+ tier required.** operationId: getNetFlows parameters: - $ref: '#/components/parameters/source' - $ref: '#/components/parameters/address' - $ref: '#/components/parameters/from' - $ref: '#/components/parameters/to' - name: interval in: query description: Aggregation interval. schema: type: string enum: - 1h - 4h - 8h - 1d - 7d default: 1d - $ref: '#/components/parameters/limit' responses: '200': description: Net flow time series. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/NetFlow' '400': $ref: '#/components/responses/QueryWindowExceeded' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '504': $ref: '#/components/responses/QueryTimeout' components: parameters: source: name: source in: query description: Venue identifier. Defaults to `hyperliquid`. schema: type: string enum: - hyperliquid default: hyperliquid example: hyperliquid address: name: address in: query description: Wallet address filter (hex string, e.g. `0xabc123`). schema: type: string example: '0xabc123def456' from: name: from in: query description: >- Start time as Unix milliseconds. Defaults to 24 hours ago. Clamped to tier history window. On /v1/trades and /v1/fills, the time range (to - from) is limited per tier (no key 1h, free key 6h, Explorer 24h, Builder 7d, Enterprise unlimited; without market filter 4h for all tiers). Returns QUERY_WINDOW_EXCEEDED (400) if exceeded — paginate with narrower from/to windows. schema: type: integer format: int64 example: 1718313600000 to: name: to in: query description: End time as Unix milliseconds. Defaults to now. schema: type: integer format: int64 example: 1718400000000 limit: name: limit in: query description: Maximum number of results per page. Default 100, max 1000. schema: type: integer default: 100 maximum: 1000 example: 100 schemas: NetFlow: type: object required: - timestamp - deposits - withdrawals - net properties: timestamp: type: integer format: int64 example: 1718400000000 deposits: type: string example: '1500000.00' withdrawals: type: string example: '800000.00' net: type: string example: '700000.00' Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Machine-readable error code. example: RATE_LIMIT_EXCEEDED message: type: string description: Human-readable error description. example: Rate limit exceeded. Retry after 60 seconds. responses: QueryWindowExceeded: description: >- Time range exceeds the per-request maximum for the caller's tier. Narrow the from/to window and paginate. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: QUERY_WINDOW_EXCEEDED message: >- query time range exceeds maximum 24h0m0s per request for your tier — narrow your from/to window and paginate Unauthorized: description: Missing or invalid API key. headers: WWW-Authenticate: schema: type: string example: Bearer content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: UNAUTHORIZED message: Invalid or missing API key Forbidden: description: Your tier does not include this feature. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: TIER_FORBIDDEN message: Export requires Builder tier or above RateLimited: description: Rate limit exceeded. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer example: 60 content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: RATE_LIMIT_EXCEEDED message: Rate limit exceeded. Retry after 60 seconds. InternalError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: INTERNAL_ERROR message: An unexpected error occurred QueryTimeout: description: >- Query exceeded the 15-second execution limit. Narrow your time range, add a market filter, or reduce the limit. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: QUERY_TIMEOUT message: >- query took too long — narrow your time range, add a market filter, or reduce the limit securitySchemes: bearerAuth: type: http scheme: bearer description: >- Ironflow API key, format `if_xxxx`. Free keys at https://ironflow.sh/key. Optional on read endpoints. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.