REST API›Link›Link Accounts

GET

List Link accounts eligible as withdrawal sources

Returns one row per (account, accountSubType) for accounts the caller has link.account.transfer on, with non-zero available balance for the given asset. When asset is supplied, additionally filters to rows whose venue supports (genericAsset, network) for withdrawals (capability lookup, not the on/off withdraw_disabled gate). Excludes accounts whose status != active.

Exactly one of asset / genericAsset is required.

Path Params

  • enterpriseId string required
    Your enterprise id.

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

Query Params

  • genericAsset string
    Network-agnostic asset family (e.g. "usdc"). When omitted (along with network), the endpoint returns accounts with a positive balance in any asset.

    at least 1 characters

  • network string
    BitGo network identifier (e.g. "sol", "eth"). Requires genericAsset. When supplied, only venues that support the (genericAsset, network) pair are included.

    at least 1 characters

  • name string
    Filter sources by name (case-insensitive partial match).

    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

Response for GET /api/link/v1/enterprises/{enterpriseId}/sources.

Pagination is account-level offset/limit. Each LinkAccountEligibilityRow corresponds to one account and carries one entry per funding subtype with a positive balance. A response with accounts.length < limit means end-of-stream; accounts.length === limit means the next offset may produce more accounts.

  • accounts array of objects required
    accounts object
    • id string required
    • name string required

      at least 1 characters

    • venueId string required

      at least 1 characters

    • venueName string required

      at least 1 characters

    • whitelistingEnabled boolean required
    • 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
      subAccounts object
      • id string required
      • name string required

        at least 1 characters

      • venueId string required

        at least 1 characters

      • venueName string required

        at least 1 characters

      • whitelistingEnabled boolean required
      • 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

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