REST API›Link›Link Accounts

GET

Get permitted accounts balances for an enterprise

Returns the latest balance snapshots per asset for permitted accounts. When optional query param accountIds is provided, returns balances only for those account IDs; when omitted, returns all permitted accounts in the enterprise. Optional venue restricts accounts by venueId; optional repeated genericAsset restricts balance rows to those genericAsset values. Each account includes its permitted sub-account balances. Returns an empty array if no accounts are found.

Path Params

  • enterpriseId string required
    Your enterprise id.

    at least 1 characters · matches ^[0-9a-f]{32}$

Query Params

  • accountIds array of strings
    Optional list of account IDs. When provided, returns balances only for these accounts; when omitted, returns all permitted accounts.
  • venue string
    When provided, only accounts at this venue (Account.venueId) are included.

    at least 1 characters

  • genericAsset array of strings
    When provided (repeat param), only balances whose genericAsset is in this list are returned.
  • displayAsset array of strings
    When provided (repeat param), only balances whose displayAsset is in this list are returned. displayAsset equals genericAsset when mapped, otherwise rawAsset.
  • searchLabel string
    Case-insensitive partial match against account name. Filters accounts whose name contains the value.

    at least 1 characters

  • limit string or number required
    Maximum number of results to return per page. Defaults to 50.

    ONE OF

    string
  • offset string or number required
    Number of results to skip before returning. Defaults to 0.

    ONE OF

    string

Header Params

  • user-id string required
    User id of the user making the request.

    at least 1 characters

Responses

200
OK

Response Body

object

Top-level response for GET enterprise accounts balances
  • accounts array of objects required
    accounts object
    • id string required
    • venueId string required

      at least 1 characters

    • status string enum required
      activeinactivedeletedpending_credentials
    • name string required

      at least 1 characters

    • accountSubTypes array of objects required
      accountSubTypes object
      • balances array of objects required
        balances object
        • rawAsset string required

          at least 1 characters

        • genericAsset string

          at least 1 characters

        • displayAsset string required

          at least 1 characters

        • asset string

          at least 1 characters

        • network string

          at least 1 characters

        • available string required
        • locked string required

          at least 1 characters

        • total string required

          at least 1 characters

        • asOfDate string date-time required
      • accountSubType string required
        Normalized sub-account-type identifier (e.g. SPOT, MARGIN, UNIFIED). Read directly from the Link DB column populated by the normalized-balances Kafka consumer.

        at least 1 characters

      • rawAccountSubType string
        Venue-raw sub-type label, projected from AccountSubTypeDefinition.rawType for the matching normalized entry in the venue config. Absent for pass-through values.

        at least 1 characters

      • accountSubTypeLabel string
        Human-readable sub-type display label, projected from AccountSubTypeDefinition.displayName. Absent when the venue has only one sub-type, or for pass-through values.

        at least 1 characters

    • subAccounts array of objects required
      subAccounts object
      • id string required
      • status string enum required
        activeinactivedeletedpending_credentials
      • name string required

        at least 1 characters

      • accountSubTypes array of objects required
        accountSubTypes object
        • balances array of objects required
          balances object
          • rawAsset string required

            at least 1 characters

          • genericAsset string

            at least 1 characters

          • displayAsset string required

            at least 1 characters

          • asset string

            at least 1 characters

          • network string

            at least 1 characters

          • available string required
          • locked string required

            at least 1 characters

          • total string required

            at least 1 characters

          • asOfDate string date-time required
        • accountSubType string required
          Normalized sub-account-type identifier (e.g. SPOT, MARGIN, UNIFIED). Read directly from the Link DB column populated by the normalized-balances Kafka consumer.

          at least 1 characters

        • rawAccountSubType string
          Venue-raw sub-type label, projected from AccountSubTypeDefinition.rawType for the matching normalized entry in the venue config. Absent for pass-through values.

          at least 1 characters

        • accountSubTypeLabel string
          Human-readable sub-type display label, projected from AccountSubTypeDefinition.displayName. Absent when the venue has only one sub-type, or for pass-through values.

          at least 1 characters

  • total number required
400
Bad Request
No response body
401
Unauthorized

Response Body

object

  • errorName string required
  • error string required
403
Forbidden

Response Body

object

  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

  • errorName string required
  • error string required