Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
portfolio
/
summary
curl
curl -X GET "https://api.services.payward.com/v1/accounts/ABCD1234EFGH5678/portfolio/summary" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"
{
  "data": {
    "quote_symbol": "USD",
    "quote_type": "fiat",
    "value": "12500.42",
    "cost_basis": "10000.00",
    "available": "2500.00",
    "withheld": "125.00",
    "open_orders": "125.00",
    "pnl": {
      "unrealized": "2500.42"
    }
  }
}

Authorizations

​
API-Key
string
header
required

Your public API key. Identifies the partner making the request.

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Path Parameters

​
account_id
string
required

ID of the account the request applies to. This refers to one of the accounts held by the user the request is acting on behalf of (typically the user's main account, but any of the user's accounts is accepted). Routes the request to that specific account container. Canonical identifier for an account in the Payward public API.

Required string length: 14 - 42

Query Parameters

​
quote_symbol
string
default:USD

Ticker symbol of the fiat quote asset to use for all valuations and PnL calculations in the response (e.g. USD, EUR). Defaults to USD. Ticker symbol of an asset (e.g. BTC, USDC, EUR).

Required string length: 3 - 16
Example:

"BTC"

​
quote_type
enum<string>
default:fiat

Classification of the quote asset. Currently only fiat is supported.

Available options:
fiat

Response

Response

​
data
object
required