Portfolio

GenerateReport generates and streams a report file for download

get

/portfolio/v1/generate

Uses the reporters registered for report_type/format (see x/portfolio/infra/reporters) — account_id defaults to the caller's own account and requires the :all scope to query on behalf of another

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

reportTypestringRequired

report_type identifies the kind of report to generate (e.g. "trade")

formatstringRequired

format identifies the output format (e.g. "csv", "pdf")

startDatestring · date-timeOptional

start_date is the optional inclusive start of the report date range

endDatestring · date-timeOptional

end_date is the optional inclusive end of the report date range

accountIdstringRequired

account_id is optional; absent means self-service (from auth context). Providing it requires the reports.generate.read:all scope (admin).

Responses

200

A successful response.

application/json

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.

This message can be used both in streaming and non-streaming API methods in the request as well as the response.

It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Example with streaming methods:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

contentTypestringOptional

The HTTP Content-Type header value specifying the content type of the body.

datastring · byteOptional

The HTTP request/response body as raw binary.

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/portfolio/v1/generate

GET /portfolio/v1/generate?reportType=text&format=text&accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "contentType": "text",
  "data": "Ynl0ZXM=",
  "extensions": [
    {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

GetPortfolio returns the aggregated holdings for an account

get

/portfolio/v1/portfolio

Aggregates custodial ledger balances, Privy-managed wallet balances, and caller-supplied external wallet balances into a single USD-valued view

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

accountIdstringRequired

evmstringOptional

evm is a caller-owned EVM wallet to include alongside the internal ones

tronstringOptional

tron is a caller-owned Tron wallet to include alongside the internal ones

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/portfolio/v1/portfolio

GET /portfolio/v1/portfolio?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "crypto": [
    {
      "address": "text",
      "chainId": "text",
      "tokenAddress": "text",
      "tokenBalance": "text",
      "tokenMetadata": {
        "decimals": 1,
        "enabled": true,
        "id": 1,
        "logo": "text",
        "name": "text",
        "stable": true,
        "symbol": "text"
      }
    }
  ],
  "fiat": [
    {
      "amount": "text",
      "available": "text",
      "decimals": 1,
      "fiatAssetCode": "text",
      "locked": "text",
      "logo": "text",
      "name": "text",
      "symbol": "text",
      "usdValue": "text"
    }
  ],
  "summary": {
    "external": {
      "sources": [
        {
          "address": "text",
          "network": "text",
          "type": "text",
          "usdValue": "text"
        }
      ],
      "usdValue": "text"
    },
    "internal": {
      "sources": [
        {
          "address": "text",
          "network": "text",
          "type": "text",
          "usdValue": "text"
        }
      ],
      "usdValue": "text"
    },
    "totalUsd": "text"
  }
}

GetTokensByWallet returns tokens held by EVM and/or Tron wallet addresses across supported chains

get

/portfolio/v1/tokens-by-wallet

Queries on-chain balances directly, not the internal ledger. At least one of evm or tron must be provided

Query parameters

evmstringOptional

evm is an EVM-compatible wallet address (0x-prefixed, 20 bytes)

tronstringOptional

tron is a Tron wallet address (base58, starts with T)

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/portfolio/v1/tokens-by-wallet

GET /portfolio/v1/tokens-by-wallet HTTP/1.1
Host: backend.pay.kiichain.io
Accept: */*

{
  "tokens": [
    {
      "address": "text",
      "chainId": "text",
      "tokenAddress": "text",
      "tokenBalance": "text",
      "tokenMetadata": {
        "decimals": 1,
        "enabled": true,
        "id": 1,
        "logo": "text",
        "name": "text",
        "stable": true,
        "symbol": "text"
      }
    }
  ]
}

PreviousNotifications NextTickets

Last updated 13 days ago