> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperdash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Borrowers

> Every account with an open HyperCore borrow, largest eligible collateral first.



## OpenAPI

````yaml /data-api/openapi.json get /v1/snapshots/borrowers
openapi: 3.1.0
info:
  title: Hyperdash Data API
  version: v1
  description: >-
    Hyperliquid data from Hyperdash's own nodes and stored datasets; requests
    never call Hyperliquid's public API. Every response reports the credits it
    cost.
servers:
  - url: https://data.hyperdash.com
security: []
tags:
  - name: Accounts
  - name: Async jobs
  - name: Builders
  - name: Cohorts
  - name: HIP-3 dexes
  - name: Leaderboards
  - name: Lending
  - name: Liquidations
  - name: Markets
  - name: 'Markets: analytics'
  - name: 'Markets: funding'
  - name: 'Markets: liquidation and stop levels'
  - name: 'Markets: open interest and positioning'
  - name: 'Markets: order book'
  - name: 'Markets: prices and candles'
  - name: 'Markets: queue priority'
  - name: 'Markets: trades and flow'
  - name: 'Markets: TWAPs'
  - name: Network
  - name: Outcomes
  - name: Positions
  - name: Referrals
  - name: Snapshots
  - name: Spot
  - name: Staking
  - name: Traders
  - name: Vaults
paths:
  /v1/snapshots/borrowers:
    get:
      tags:
        - Snapshots
      summary: Borrowers
      description: >-
        Every account with an open HyperCore borrow, largest eligible collateral
        first. Each row has borrowed and supplied tokens in USD, wallet HYPE and
        BTC collateral, eligible collateral, liquidation value and maintenance
        requirement.


        **Freshness**

        - The snapshot is rebuilt at most every 60 seconds.


        **Paging**

        - Every page of one query reads the same snapshot: the cursor pins it.
        Once two newer snapshots replace it, a cursor page answers `409
        snapshot_expired`. Restart from the first page.


        **Credits:** 20 per request + 1 per row.


        **Scope:** `analytics:read`
      operationId: snapshotBorrowers
      parameters:
        - name: limit
          in: query
          required: false
          description: Rows per page, at most 1,000.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 1000
        - name: cursor
          in: query
          required: false
          description: Opaque cursor from `next_cursor`. It pins the snapshot.
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            X-Credits-Charged:
              schema:
                type: integer
            X-Credit-Price-Version:
              schema:
                type: integer
            X-Request-Id:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - has_more
                  - next_cursor
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        address:
                          type: string
                          description: Wallet.
                        mode:
                          type: string
                          description: Margin mode.
                        borrowed_usd:
                          type: string
                          description: Borrowed, in USD. Decimal string.
                        supplied_usd:
                          type: string
                          description: Supplied, in USD. Decimal string.
                        eligible_collateral_usd:
                          type: string
                          description: Eligible collateral, in USD. Decimal string.
                        liquidation_value:
                          type: string
                          description: Liquidation value, in USD. Decimal string.
                        maintenance:
                          type: string
                          description: Maintenance requirement, in USD. Decimal string.
                        wallet_hype_usd:
                          type: string
                          description: Wallet HYPE, in USD. Decimal string.
                        wallet_btc_usd:
                          type: string
                          description: Wallet BTC, in USD. Decimal string.
                        unpriced:
                          type: boolean
                          description: Some leg had no oracle price.
                        borrows:
                          type: string
                          description: >-
                            Borrow legs, as JSON with `token`, `name`, `amount`,
                            `usd` and `ltv`.
                        supplies:
                          type: string
                          description: Supply legs, as JSON.
                    description: Result rows.
                  has_more:
                    type: boolean
                    description: '`true` when another page follows.'
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Cursor for the next page, passed as `cursor`. `null` on
                      the last page.
                  meta:
                    type: object
                    description: >-
                      Response metadata. Its keys depend on the endpoint and are
                      described above.
        '400':
          description: 'Invalid parameter (also: a request body that is not valid JSON)'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: Invalid, expired or revoked key
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Scope, plan, history or credit limit
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: Price version changed, or a cursor's snapshot expired
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            Rate limited (Retry-After; free): request rate, concurrent requests
            (a request counts one slot per 1,000 rows it can return), or this
            server busy with your workspace's requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '502':
          description: Upstream data source failed (free; retry later)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Backend at capacity or temporarily unavailable (Retry-After)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '504':
          description: Upstream data source timed out (free; retry later)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearer: []
      x-codeSamples:
        - lang: curl
          source: >-
            curl -H "Authorization: Bearer $HYPERDASH_API_KEY"
            'https://data.hyperdash.com/v1/snapshots/borrowers'
components:
  schemas:
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
        - request_id
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
        hint:
          type: string
        request_id:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Your API key, sent as `Bearer hdk_sk_live_v1_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.