⚙️
1Konto v1.0 API Docs
  • Welcome!
  • Reference
    • API Reference
    • Service
      • Service Information
      • Service Time
    • Authentication
      • Login and Authentication
    • Market Data
      • Get Top of Book
      • Get Order Book
    • Accounting
      • Get Account
      • Get Account Credit
      • Get Transactions
      • Transfers Instructions
        • Get Deposit Instructions
        • Get Withdraw Instructions
      • Withdraw Requests
        • Request Withdraw - Fiat
        • Request Withdraw - Blockchain
        • Querying for Withdraw Requests
    • Orders
      • Available Asset Pairs
      • Request Indicative Price
      • Market Order
      • Limit Order
      • RFQ - Request for Quote
        • Request Quote
        • Accept Quote
      • Querying for Orders
      • Get Order
Powered by GitBook
On this page
  • Account
  • Example
  1. Reference
  2. Accounting

Get Account Credit

requires auth

Account

Endpoint to retrieve account credit information. Mostly used to obtain credit available, credit used and credit limit.

GET /api/v1/accounting/account/{accountId}/portfolio

Path Parameters:

Path
Type
Description

accountId*

string

your account ID

Example

GET /api/v1/accounting/account/test123/portfolio
// Successful Response body
{
  "account": {
    "accountId": "test123",
    "type": "client",
    "name": "Test",
    "balances": {
      "USDC": {
        "availableToTrade": 10000.0,
        "totalFunds": 0.0,
        "availableFunds": 0.0,
        "lockedFunds": 0.0,
        "totalCredit": 10000.0,
        "availableCredit": 10000.0,
        "usedCredit": 0.0
      },
      "USDT": {
        "availableToTrade": 10000.0,
        "totalFunds": 0.0,
        "availableFunds": 0.0,
        "lockedFunds": 0.0,
        "totalCredit": 10000.0,
        "availableCredit": 10000.0,
        "usedCredit": 0.0
      },
      "USD": {
        "availableToTrade": 10000.0,
        "totalFunds": 0.0,
        "availableFunds": 0.0,
        "lockedFunds": 0.0,
        "totalCredit": 10000.0,
        "availableCredit": 10000.0,
        "usedCredit": 0.0
      }
    },
    "sources": []
  },
  "notationalAsset": "USD",
  "notionalTotals": {
    "availableToTrade": 29997.19990373039232,
    "totalFunds": 0.0,
    "availableFunds": 0.0,
    "lockedFunds": 0.0,
    "totalCredit": 29997.19990373039232,
    "availableCredit": 29997.19990373039232,
    "usedCredit": 0.0
  },
  "status": "ok",
  "httpStatusCode": 200
}
// Error Response body
{
  "status": 404,
  "error": "Account ID Not Found"
}

PreviousGet AccountNextGet Transactions

Last updated 1 year ago

Page cover image