@compass-labs/api-sdk 2.2.66 → 2.2.67-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/codeSamples_typescript.yaml +6 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +25 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js +130 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +5 -0
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js +2 -0
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
- package/dist/commonjs/models/components/creditevent.d.ts +4 -4
- package/dist/commonjs/models/components/creditevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditevent.js +4 -5
- package/dist/commonjs/models/components/creditevent.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +2 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +2 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetsactivityevent.d.ts +79 -0
- package/dist/commonjs/models/components/tokenizedassetsactivityevent.d.ts.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetsactivityevent.js +84 -0
- package/dist/commonjs/models/components/tokenizedassetsactivityevent.js.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.d.ts +36 -0
- package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.js +59 -0
- package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +1 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +1 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.d.ts +37 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.d.ts.map +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.js +62 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsbalances.js.map +1 -0
- package/dist/commonjs/sdk/tokenizedassets.d.ts +13 -0
- package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/commonjs/sdk/tokenizedassets.js +16 -0
- package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +25 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js +94 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -0
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +5 -0
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js +2 -0
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
- package/dist/esm/models/components/creditevent.d.ts +4 -4
- package/dist/esm/models/components/creditevent.d.ts.map +1 -1
- package/dist/esm/models/components/creditevent.js +3 -4
- package/dist/esm/models/components/creditevent.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +2 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +2 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/tokenizedassetsactivityevent.d.ts +79 -0
- package/dist/esm/models/components/tokenizedassetsactivityevent.d.ts.map +1 -0
- package/dist/esm/models/components/tokenizedassetsactivityevent.js +47 -0
- package/dist/esm/models/components/tokenizedassetsactivityevent.js.map +1 -0
- package/dist/esm/models/components/tokenizedassetsbalancesresponse.d.ts +36 -0
- package/dist/esm/models/components/tokenizedassetsbalancesresponse.d.ts.map +1 -0
- package/dist/esm/models/components/tokenizedassetsbalancesresponse.js +22 -0
- package/dist/esm/models/components/tokenizedassetsbalancesresponse.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +1 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +1 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsbalances.d.ts +37 -0
- package/dist/esm/models/operations/v2tokenizedassetsbalances.d.ts.map +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsbalances.js +25 -0
- package/dist/esm/models/operations/v2tokenizedassetsbalances.js.map +1 -0
- package/dist/esm/sdk/tokenizedassets.d.ts +13 -0
- package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/esm/sdk/tokenizedassets.js +16 -0
- package/dist/esm/sdk/tokenizedassets.js.map +1 -1
- package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md +16 -14
- package/docs/models/components/creditevent.md +1 -1
- package/docs/models/components/{eventtype.md → crediteventeventtype.md} +3 -3
- package/docs/models/components/tokenizedassetsactivityevent.md +40 -0
- package/docs/models/components/tokenizedassetsactivityeventeventtype.md +17 -0
- package/docs/models/components/tokenizedassetsbalancesresponse.md +28 -0
- package/docs/models/operations/v2tokenizedassetsbalanceschain.md +17 -0
- package/docs/models/operations/v2tokenizedassetsbalancesrequest.md +18 -0
- package/docs/sdks/tokenizedassets/README.md +81 -0
- package/openapi_prepped_for_speakeasy.json +220 -0
- package/package.json +1 -1
- package/src/funcs/tokenizedAssetsTokenizedAssetsBalances.ts +184 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts +9 -0
- package/src/models/components/creditevent.ts +7 -6
- package/src/models/components/index.ts +2 -0
- package/src/models/components/tokenizedassetsactivityevent.ts +132 -0
- package/src/models/components/tokenizedassetsbalancesresponse.ts +70 -0
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/v2tokenizedassetsbalances.ts +65 -0
- package/src/sdk/tokenizedassets.ts +24 -0
|
@@ -15,22 +15,24 @@ let value:
|
|
|
15
15
|
contractAddress: "<value>",
|
|
16
16
|
decimals: 301840,
|
|
17
17
|
balance: "<value>",
|
|
18
|
+
events: [],
|
|
18
19
|
};
|
|
19
20
|
```
|
|
20
21
|
|
|
21
22
|
## Fields
|
|
22
23
|
|
|
23
|
-
| Field | Type | Required | Description |
|
|
24
|
-
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
25
|
-
| `symbol` | *string* | :heavy_check_mark: | On-chain Ondo symbol (e.g. `TSLAon`). |
|
|
26
|
-
| `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker. |
|
|
27
|
-
| `name` | *string* | :heavy_check_mark: | Underlying equity name (or ticker fallback). |
|
|
28
|
-
| `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address. |
|
|
29
|
-
| `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals. |
|
|
30
|
-
| `balance` | *string* | :heavy_check_mark: | Human-readable balance (already scaled by `decimals`). |
|
|
31
|
-
| `currentPriceUsd` | *string* | :heavy_minus_sign: | USD spot price at read time (decimal string). |
|
|
32
|
-
| `balanceUsd` | *string* | :heavy_minus_sign: | `balance * current_price_usd` when the price is available. |
|
|
33
|
-
| `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_minus_sign: | Issuer/provider of a tokenized asset. |
|
|
34
|
-
| `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_minus_sign: | Asset class of a tokenized asset.<br/><br/>`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA<br/>yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) trade via the<br/>swap-based `transact/buy` and `transact/sell` endpoints. |
|
|
35
|
-
| `chain` | [components.Chain](../../models/components/chain.md) | :heavy_minus_sign: | The chain to use. |
|
|
36
|
-
| `pnl` | [components.TokenizedAssetsPnl](../../models/components/tokenizedassetspnl.md) | :heavy_minus_sign: | Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis). |
|
|
24
|
+
| Field | Type | Required | Description | Example |
|
|
25
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `symbol` | *string* | :heavy_check_mark: | On-chain Ondo symbol (e.g. `TSLAon`). | |
|
|
27
|
+
| `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker. | |
|
|
28
|
+
| `name` | *string* | :heavy_check_mark: | Underlying equity name (or ticker fallback). | |
|
|
29
|
+
| `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address. | |
|
|
30
|
+
| `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals. | |
|
|
31
|
+
| `balance` | *string* | :heavy_check_mark: | Human-readable balance (already scaled by `decimals`). | |
|
|
32
|
+
| `currentPriceUsd` | *string* | :heavy_minus_sign: | USD spot price at read time (decimal string). | |
|
|
33
|
+
| `balanceUsd` | *string* | :heavy_minus_sign: | `balance * current_price_usd` when the price is available. | |
|
|
34
|
+
| `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_minus_sign: | Issuer/provider of a tokenized asset. | |
|
|
35
|
+
| `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_minus_sign: | Asset class of a tokenized asset.<br/><br/>`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA<br/>yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) trade via the<br/>swap-based `transact/buy` and `transact/sell` endpoints. | |
|
|
36
|
+
| `chain` | [components.Chain](../../models/components/chain.md) | :heavy_minus_sign: | The chain to use. | |
|
|
37
|
+
| `pnl` | [components.TokenizedAssetsPnl](../../models/components/tokenizedassetspnl.md) | :heavy_minus_sign: | Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis). | |
|
|
38
|
+
| `events` | [components.TokenizedAssetsActivityEvent](../../models/components/tokenizedassetsactivityevent.md)[] | :heavy_minus_sign: | Chronological activity for this position (buy / sell / transfer_in / transfer_out). Pure-USDC funding is excluded — it appears on the balances endpoint. | [] |
|
|
@@ -21,7 +21,7 @@ let value: CreditEvent = {
|
|
|
21
21
|
|
|
22
22
|
| Field | Type | Required | Description |
|
|
23
23
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
24
|
-
| `eventType` | [components.
|
|
24
|
+
| `eventType` | [components.CreditEventEventType](../../models/components/crediteventeventtype.md) | :heavy_check_mark: | Type of credit event. |
|
|
25
25
|
| `blockNumber` | *number* | :heavy_check_mark: | Block number when the event occurred |
|
|
26
26
|
| `blockTimestamp` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Timestamp when the event occurred |
|
|
27
27
|
| `transactionHash` | *string* | :heavy_check_mark: | Transaction hash of the event |
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreditEventEventType
|
|
2
2
|
|
|
3
3
|
Type of credit event.
|
|
4
4
|
|
|
5
5
|
## Example Usage
|
|
6
6
|
|
|
7
7
|
```typescript
|
|
8
|
-
import {
|
|
8
|
+
import { CreditEventEventType } from "@compass-labs/api-sdk/models/components";
|
|
9
9
|
|
|
10
|
-
let value:
|
|
10
|
+
let value: CreditEventEventType = "supply";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Values
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# TokenizedAssetsActivityEvent
|
|
2
|
+
|
|
3
|
+
One classified activity event on a tokenized-asset position.
|
|
4
|
+
|
|
5
|
+
Mirrors Earn's deposit/withdrawal event shape (generic ``input``/``output``
|
|
6
|
+
legs) with an ``event_type`` discriminator, so buys, sells and transfers share
|
|
7
|
+
one chronological feed. A ``buy`` has ``input`` = USDC paid and ``output`` =
|
|
8
|
+
tokens received (``cost_per_unit`` = USDC/token); a ``sell`` is the reverse and
|
|
9
|
+
carries ``realized_pnl``; a ``transfer_in``/``transfer_out`` carries only the
|
|
10
|
+
token leg, so the opposite side is ``null``. All amounts are decimal strings.
|
|
11
|
+
Pure-USDC funding movements are not position activity — they appear on the
|
|
12
|
+
balances endpoint.
|
|
13
|
+
|
|
14
|
+
## Example Usage
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { TokenizedAssetsActivityEvent } from "@compass-labs/api-sdk/models/components";
|
|
18
|
+
|
|
19
|
+
let value: TokenizedAssetsActivityEvent = {
|
|
20
|
+
eventType: "transfer_in",
|
|
21
|
+
blockNumber: 994798,
|
|
22
|
+
blockTimestamp: new Date("2026-12-04T02:29:02.271Z"),
|
|
23
|
+
transactionHash: "<value>",
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Fields
|
|
28
|
+
|
|
29
|
+
| Field | Type | Required | Description |
|
|
30
|
+
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
31
|
+
| `eventType` | [components.TokenizedAssetsActivityEventEventType](../../models/components/tokenizedassetsactivityeventeventtype.md) | :heavy_check_mark: | Kind of activity for this transaction. |
|
|
32
|
+
| `blockNumber` | *number* | :heavy_check_mark: | Block the transaction was mined in. |
|
|
33
|
+
| `blockTimestamp` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Time the transaction was mined. |
|
|
34
|
+
| `transactionHash` | *string* | :heavy_check_mark: | Transaction hash. |
|
|
35
|
+
| `inputAmount` | *string* | :heavy_minus_sign: | Amount sent: USDC for a buy, tokens for a sell/transfer_out. |
|
|
36
|
+
| `inputSymbol` | *string* | :heavy_minus_sign: | Symbol of the sent leg, or `null` for a transfer_in. |
|
|
37
|
+
| `outputAmount` | *string* | :heavy_minus_sign: | Amount received: tokens for a buy/transfer_in, USDC for a sell. |
|
|
38
|
+
| `outputSymbol` | *string* | :heavy_minus_sign: | Symbol of the received leg, or `null` for a transfer_out. |
|
|
39
|
+
| `costPerUnit` | *string* | :heavy_minus_sign: | Cost basis per token at buy time; `null` for non-buys. |
|
|
40
|
+
| `realizedPnl` | *string* | :heavy_minus_sign: | Realized profit/loss on a sell; `null` for non-sells. |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TokenizedAssetsActivityEventEventType
|
|
2
|
+
|
|
3
|
+
Kind of activity for this transaction.
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { TokenizedAssetsActivityEventEventType } from "@compass-labs/api-sdk/models/components";
|
|
9
|
+
|
|
10
|
+
let value: TokenizedAssetsActivityEventEventType = "transfer_in";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"buy" | "sell" | "transfer_in" | "transfer_out"
|
|
17
|
+
```
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# TokenizedAssetsBalancesResponse
|
|
2
|
+
|
|
3
|
+
Token balances and transfer history for a Tokenized Assets Account.
|
|
4
|
+
|
|
5
|
+
Unlike `/positions` (current equity holdings only, priced), this surfaces
|
|
6
|
+
every token the account has ever transferred — each with its full transfer
|
|
7
|
+
history — including **USDC funding** movements and **fully-sold positions**
|
|
8
|
+
(zero balance). It is the account's cash + activity ledger. Balances are keyed
|
|
9
|
+
by token symbol, reusing the same `TokenBalance`/`TokenTransfer` shape as the
|
|
10
|
+
earn and credit balances endpoints.
|
|
11
|
+
|
|
12
|
+
## Example Usage
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { TokenizedAssetsBalancesResponse } from "@compass-labs/api-sdk/models/components";
|
|
16
|
+
|
|
17
|
+
let value: TokenizedAssetsBalancesResponse = {
|
|
18
|
+
tokenizedAssetsAccountAddress: "<value>",
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Fields
|
|
23
|
+
|
|
24
|
+
| Field | Type | Required | Description |
|
|
25
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `tokenizedAssetsAccountAddress` | *string* | :heavy_check_mark: | The derived Tokenized Assets Account address. |
|
|
27
|
+
| `balances` | Record<string, [components.CompassApiBackendV2ModelsBalancesTokenBalance](../../models/components/compassapibackendv2modelsbalancestokenbalance.md)> | :heavy_minus_sign: | Token balances keyed by token symbol, including USDC cash and fully-sold positions (zero balance). Each carries its transfer history. |
|
|
28
|
+
| `totalUsdValue` | *string* | :heavy_minus_sign: | Total USD value of all priced balances. |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# V2TokenizedAssetsBalancesChain
|
|
2
|
+
|
|
3
|
+
The chain to use.
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { V2TokenizedAssetsBalancesChain } from "@compass-labs/api-sdk/models/operations";
|
|
9
|
+
|
|
10
|
+
let value: V2TokenizedAssetsBalancesChain = "ethereum";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo"
|
|
17
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# V2TokenizedAssetsBalancesRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { V2TokenizedAssetsBalancesRequest } from "@compass-labs/api-sdk/models/operations";
|
|
7
|
+
|
|
8
|
+
let value: V2TokenizedAssetsBalancesRequest = {
|
|
9
|
+
owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description | Example |
|
|
16
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `owner` | *string* | :heavy_check_mark: | The address of the owner of the Tokenized Assets Account to read balances for. The account address is derived deterministically from this owner; balances are read from the derived account. | 0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B |
|
|
18
|
+
| `chain` | [operations.V2TokenizedAssetsBalancesChain](../../models/operations/v2tokenizedassetsbalanceschain.md) | :heavy_minus_sign: | Network to read balances on (defaults to Ethereum). Equities exist on Ethereum only; RWA yield assets also exist on Base. | |
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
* [tokenizedAssetsMarkets](#tokenizedassetsmarkets) - List tokenized asset markets
|
|
8
8
|
* [tokenizedAssetsMarketsSymbol](#tokenizedassetsmarketssymbol) - Get a single market
|
|
9
9
|
* [tokenizedAssetsPositions](#tokenizedassetspositions) - Get tokenized-asset positions for an owner
|
|
10
|
+
* [tokenizedAssetsBalances](#tokenizedassetsbalances) - Get tokenized-asset account balances + transfer history
|
|
10
11
|
* [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get tokenized-equity order status (Ondo)
|
|
11
12
|
* [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create a Tokenized Assets Account
|
|
12
13
|
* [tokenizedAssetsTransfer](#tokenizedassetstransfer) - Deposit to / withdraw from a Tokenized Assets Account
|
|
@@ -280,6 +281,86 @@ run();
|
|
|
280
281
|
| errors.TokenizedAssetsErrorResponse | 502 | application/json |
|
|
281
282
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
282
283
|
|
|
284
|
+
## tokenizedAssetsBalances
|
|
285
|
+
|
|
286
|
+
Get the full token ledger for a Tokenized Assets Account.
|
|
287
|
+
|
|
288
|
+
Returns every token the account has transferred — current balances plus
|
|
289
|
+
complete transfer history — keyed by symbol. Unlike `/positions` (current
|
|
290
|
+
equity holdings, priced), this includes **USDC funding** movements and
|
|
291
|
+
**fully-sold positions** (zero balance), making it the account's cash +
|
|
292
|
+
activity ledger. Pass `chain=base` for Base holdings.
|
|
293
|
+
|
|
294
|
+
### Example Usage
|
|
295
|
+
|
|
296
|
+
<!-- UsageSnippet language="typescript" operationID="v2_tokenized_assets_balances" method="get" path="/v2/tokenized_assets/balances" -->
|
|
297
|
+
```typescript
|
|
298
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
299
|
+
|
|
300
|
+
const compassApiSDK = new CompassApiSDK({
|
|
301
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
302
|
+
});
|
|
303
|
+
|
|
304
|
+
async function run() {
|
|
305
|
+
const result = await compassApiSDK.tokenizedAssets.tokenizedAssetsBalances({
|
|
306
|
+
owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
console.log(result);
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
run();
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Standalone function
|
|
316
|
+
|
|
317
|
+
The standalone function version of this method:
|
|
318
|
+
|
|
319
|
+
```typescript
|
|
320
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
321
|
+
import { tokenizedAssetsTokenizedAssetsBalances } from "@compass-labs/api-sdk/funcs/tokenizedAssetsTokenizedAssetsBalances.js";
|
|
322
|
+
|
|
323
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
324
|
+
// You can create one instance of it to use across an application.
|
|
325
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
326
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
327
|
+
});
|
|
328
|
+
|
|
329
|
+
async function run() {
|
|
330
|
+
const res = await tokenizedAssetsTokenizedAssetsBalances(compassApiSDK, {
|
|
331
|
+
owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
332
|
+
});
|
|
333
|
+
if (res.ok) {
|
|
334
|
+
const { value: result } = res;
|
|
335
|
+
console.log(result);
|
|
336
|
+
} else {
|
|
337
|
+
console.log("tokenizedAssetsTokenizedAssetsBalances failed:", res.error);
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
run();
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Parameters
|
|
345
|
+
|
|
346
|
+
| Parameter | Type | Required | Description |
|
|
347
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
348
|
+
| `request` | [operations.V2TokenizedAssetsBalancesRequest](../../models/operations/v2tokenizedassetsbalancesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
349
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
350
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
351
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
352
|
+
|
|
353
|
+
### Response
|
|
354
|
+
|
|
355
|
+
**Promise\<[components.TokenizedAssetsBalancesResponse](../../models/components/tokenizedassetsbalancesresponse.md)\>**
|
|
356
|
+
|
|
357
|
+
### Errors
|
|
358
|
+
|
|
359
|
+
| Error Type | Status Code | Content Type |
|
|
360
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
361
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
362
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
363
|
+
|
|
283
364
|
## tokenizedAssetsOrderOrderHash
|
|
284
365
|
|
|
285
366
|
Get the lifecycle state of a submitted tokenized-**equity** order (Ondo).
|
|
@@ -7404,6 +7404,70 @@
|
|
|
7404
7404
|
"x-speakeasy-name-override": "tokenized_assets_positions"
|
|
7405
7405
|
}
|
|
7406
7406
|
},
|
|
7407
|
+
"/v2/tokenized_assets/balances": {
|
|
7408
|
+
"get": {
|
|
7409
|
+
"tags": [
|
|
7410
|
+
"Tokenized Assets"
|
|
7411
|
+
],
|
|
7412
|
+
"summary": "Get tokenized-asset account balances + transfer history",
|
|
7413
|
+
"description": "Get the full token ledger for a Tokenized Assets Account.\n\nReturns every token the account has transferred \u2014 current balances plus\ncomplete transfer history \u2014 keyed by symbol. Unlike `/positions` (current\nequity holdings, priced), this includes **USDC funding** movements and\n**fully-sold positions** (zero balance), making it the account's cash +\nactivity ledger. Pass `chain=base` for Base holdings.",
|
|
7414
|
+
"operationId": "v2_tokenized_assets_balances",
|
|
7415
|
+
"parameters": [
|
|
7416
|
+
{
|
|
7417
|
+
"name": "owner",
|
|
7418
|
+
"in": "query",
|
|
7419
|
+
"required": true,
|
|
7420
|
+
"schema": {
|
|
7421
|
+
"type": "string",
|
|
7422
|
+
"title": "Owner",
|
|
7423
|
+
"example": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
|
|
7424
|
+
},
|
|
7425
|
+
"description": "The address of the owner of the Tokenized Assets Account to read balances for. The account address is derived deterministically from this owner; balances are read from the derived account."
|
|
7426
|
+
},
|
|
7427
|
+
{
|
|
7428
|
+
"name": "chain",
|
|
7429
|
+
"in": "query",
|
|
7430
|
+
"required": false,
|
|
7431
|
+
"schema": {
|
|
7432
|
+
"type": "string",
|
|
7433
|
+
"enum": [
|
|
7434
|
+
"base",
|
|
7435
|
+
"ethereum",
|
|
7436
|
+
"arbitrum",
|
|
7437
|
+
"hyperevm",
|
|
7438
|
+
"tempo"
|
|
7439
|
+
],
|
|
7440
|
+
"title": "Chain",
|
|
7441
|
+
"description": "The chain to use."
|
|
7442
|
+
},
|
|
7443
|
+
"description": "Network to read balances on (defaults to Ethereum). Equities exist on Ethereum only; RWA yield assets also exist on Base."
|
|
7444
|
+
}
|
|
7445
|
+
],
|
|
7446
|
+
"responses": {
|
|
7447
|
+
"200": {
|
|
7448
|
+
"description": "Successful Response",
|
|
7449
|
+
"content": {
|
|
7450
|
+
"application/json": {
|
|
7451
|
+
"schema": {
|
|
7452
|
+
"$ref": "#/components/schemas/TokenizedAssetsBalancesResponse"
|
|
7453
|
+
}
|
|
7454
|
+
}
|
|
7455
|
+
}
|
|
7456
|
+
},
|
|
7457
|
+
"422": {
|
|
7458
|
+
"description": "Validation Error",
|
|
7459
|
+
"content": {
|
|
7460
|
+
"application/json": {
|
|
7461
|
+
"schema": {
|
|
7462
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
7463
|
+
}
|
|
7464
|
+
}
|
|
7465
|
+
}
|
|
7466
|
+
}
|
|
7467
|
+
},
|
|
7468
|
+
"x-speakeasy-name-override": "tokenized_assets_balances"
|
|
7469
|
+
}
|
|
7470
|
+
},
|
|
7407
7471
|
"/v2/tokenized_assets/order/{order_hash}": {
|
|
7408
7472
|
"get": {
|
|
7409
7473
|
"tags": [
|
|
@@ -21716,6 +21780,153 @@
|
|
|
21716
21780
|
"title": "TokenizedAssetProvider",
|
|
21717
21781
|
"description": "Issuer/provider of a tokenized asset."
|
|
21718
21782
|
},
|
|
21783
|
+
"TokenizedAssetsActivityEvent": {
|
|
21784
|
+
"properties": {
|
|
21785
|
+
"event_type": {
|
|
21786
|
+
"type": "string",
|
|
21787
|
+
"enum": [
|
|
21788
|
+
"buy",
|
|
21789
|
+
"sell",
|
|
21790
|
+
"transfer_in",
|
|
21791
|
+
"transfer_out"
|
|
21792
|
+
],
|
|
21793
|
+
"title": "Event Type",
|
|
21794
|
+
"description": "Kind of activity for this transaction."
|
|
21795
|
+
},
|
|
21796
|
+
"block_number": {
|
|
21797
|
+
"type": "integer",
|
|
21798
|
+
"title": "Block Number",
|
|
21799
|
+
"description": "Block the transaction was mined in."
|
|
21800
|
+
},
|
|
21801
|
+
"block_timestamp": {
|
|
21802
|
+
"type": "string",
|
|
21803
|
+
"format": "date-time",
|
|
21804
|
+
"title": "Block Timestamp",
|
|
21805
|
+
"description": "Time the transaction was mined."
|
|
21806
|
+
},
|
|
21807
|
+
"transaction_hash": {
|
|
21808
|
+
"type": "string",
|
|
21809
|
+
"title": "Transaction Hash",
|
|
21810
|
+
"description": "Transaction hash."
|
|
21811
|
+
},
|
|
21812
|
+
"input_amount": {
|
|
21813
|
+
"anyOf": [
|
|
21814
|
+
{
|
|
21815
|
+
"type": "string"
|
|
21816
|
+
},
|
|
21817
|
+
{
|
|
21818
|
+
"type": "null"
|
|
21819
|
+
}
|
|
21820
|
+
],
|
|
21821
|
+
"title": "Input Amount",
|
|
21822
|
+
"description": "Amount sent: USDC for a buy, tokens for a sell/transfer_out."
|
|
21823
|
+
},
|
|
21824
|
+
"input_symbol": {
|
|
21825
|
+
"anyOf": [
|
|
21826
|
+
{
|
|
21827
|
+
"type": "string"
|
|
21828
|
+
},
|
|
21829
|
+
{
|
|
21830
|
+
"type": "null"
|
|
21831
|
+
}
|
|
21832
|
+
],
|
|
21833
|
+
"title": "Input Symbol",
|
|
21834
|
+
"description": "Symbol of the sent leg, or `null` for a transfer_in."
|
|
21835
|
+
},
|
|
21836
|
+
"output_amount": {
|
|
21837
|
+
"anyOf": [
|
|
21838
|
+
{
|
|
21839
|
+
"type": "string"
|
|
21840
|
+
},
|
|
21841
|
+
{
|
|
21842
|
+
"type": "null"
|
|
21843
|
+
}
|
|
21844
|
+
],
|
|
21845
|
+
"title": "Output Amount",
|
|
21846
|
+
"description": "Amount received: tokens for a buy/transfer_in, USDC for a sell."
|
|
21847
|
+
},
|
|
21848
|
+
"output_symbol": {
|
|
21849
|
+
"anyOf": [
|
|
21850
|
+
{
|
|
21851
|
+
"type": "string"
|
|
21852
|
+
},
|
|
21853
|
+
{
|
|
21854
|
+
"type": "null"
|
|
21855
|
+
}
|
|
21856
|
+
],
|
|
21857
|
+
"title": "Output Symbol",
|
|
21858
|
+
"description": "Symbol of the received leg, or `null` for a transfer_out."
|
|
21859
|
+
},
|
|
21860
|
+
"cost_per_unit": {
|
|
21861
|
+
"anyOf": [
|
|
21862
|
+
{
|
|
21863
|
+
"type": "string"
|
|
21864
|
+
},
|
|
21865
|
+
{
|
|
21866
|
+
"type": "null"
|
|
21867
|
+
}
|
|
21868
|
+
],
|
|
21869
|
+
"title": "Cost Per Unit",
|
|
21870
|
+
"description": "Cost basis per token at buy time; `null` for non-buys."
|
|
21871
|
+
},
|
|
21872
|
+
"realized_pnl": {
|
|
21873
|
+
"anyOf": [
|
|
21874
|
+
{
|
|
21875
|
+
"type": "string"
|
|
21876
|
+
},
|
|
21877
|
+
{
|
|
21878
|
+
"type": "null"
|
|
21879
|
+
}
|
|
21880
|
+
],
|
|
21881
|
+
"title": "Realized Pnl",
|
|
21882
|
+
"description": "Realized profit/loss on a sell; `null` for non-sells."
|
|
21883
|
+
}
|
|
21884
|
+
},
|
|
21885
|
+
"type": "object",
|
|
21886
|
+
"required": [
|
|
21887
|
+
"event_type",
|
|
21888
|
+
"block_number",
|
|
21889
|
+
"block_timestamp",
|
|
21890
|
+
"transaction_hash"
|
|
21891
|
+
],
|
|
21892
|
+
"title": "TokenizedAssetsActivityEvent",
|
|
21893
|
+
"description": "One classified activity event on a tokenized-asset position.\n\nMirrors Earn's deposit/withdrawal event shape (generic ``input``/``output``\nlegs) with an ``event_type`` discriminator, so buys, sells and transfers share\none chronological feed. A ``buy`` has ``input`` = USDC paid and ``output`` =\ntokens received (``cost_per_unit`` = USDC/token); a ``sell`` is the reverse and\ncarries ``realized_pnl``; a ``transfer_in``/``transfer_out`` carries only the\ntoken leg, so the opposite side is ``null``. All amounts are decimal strings.\nPure-USDC funding movements are not position activity \u2014 they appear on the\nbalances endpoint."
|
|
21894
|
+
},
|
|
21895
|
+
"TokenizedAssetsBalancesResponse": {
|
|
21896
|
+
"properties": {
|
|
21897
|
+
"tokenized_assets_account_address": {
|
|
21898
|
+
"type": "string",
|
|
21899
|
+
"title": "Tokenized Assets Account Address",
|
|
21900
|
+
"description": "The derived Tokenized Assets Account address."
|
|
21901
|
+
},
|
|
21902
|
+
"balances": {
|
|
21903
|
+
"additionalProperties": {
|
|
21904
|
+
"$ref": "#/components/schemas/compass__api_backend__v2__models__balances__TokenBalance"
|
|
21905
|
+
},
|
|
21906
|
+
"type": "object",
|
|
21907
|
+
"title": "Balances",
|
|
21908
|
+
"description": "Token balances keyed by token symbol, including USDC cash and fully-sold positions (zero balance). Each carries its transfer history."
|
|
21909
|
+
},
|
|
21910
|
+
"total_usd_value": {
|
|
21911
|
+
"anyOf": [
|
|
21912
|
+
{
|
|
21913
|
+
"type": "string"
|
|
21914
|
+
},
|
|
21915
|
+
{
|
|
21916
|
+
"type": "null"
|
|
21917
|
+
}
|
|
21918
|
+
],
|
|
21919
|
+
"title": "Total Usd Value",
|
|
21920
|
+
"description": "Total USD value of all priced balances."
|
|
21921
|
+
}
|
|
21922
|
+
},
|
|
21923
|
+
"type": "object",
|
|
21924
|
+
"required": [
|
|
21925
|
+
"tokenized_assets_account_address"
|
|
21926
|
+
],
|
|
21927
|
+
"title": "TokenizedAssetsBalancesResponse",
|
|
21928
|
+
"description": "Token balances and transfer history for a Tokenized Assets Account.\n\nUnlike `/positions` (current equity holdings only, priced), this surfaces\nevery token the account has ever transferred \u2014 each with its full transfer\nhistory \u2014 including **USDC funding** movements and **fully-sold positions**\n(zero balance). It is the account's cash + activity ledger. Balances are keyed\nby token symbol, reusing the same `TokenBalance`/`TokenTransfer` shape as the\nearn and credit balances endpoints."
|
|
21929
|
+
},
|
|
21719
21930
|
"TokenizedAssetsBuildOrderRequest": {
|
|
21720
21931
|
"properties": {
|
|
21721
21932
|
"from_token": {
|
|
@@ -26590,6 +26801,15 @@
|
|
|
26590
26801
|
}
|
|
26591
26802
|
],
|
|
26592
26803
|
"description": "Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis)."
|
|
26804
|
+
},
|
|
26805
|
+
"events": {
|
|
26806
|
+
"items": {
|
|
26807
|
+
"$ref": "#/components/schemas/TokenizedAssetsActivityEvent"
|
|
26808
|
+
},
|
|
26809
|
+
"type": "array",
|
|
26810
|
+
"title": "Events",
|
|
26811
|
+
"description": "Chronological activity for this position (buy / sell / transfer_in / transfer_out). Pure-USDC funding is excluded \u2014 it appears on the balances endpoint.",
|
|
26812
|
+
"example": []
|
|
26593
26813
|
}
|
|
26594
26814
|
},
|
|
26595
26815
|
"type": "object",
|