@compass-labs/api-sdk 2.2.88 → 2.2.89

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.
Files changed (55) hide show
  1. package/dist/commonjs/lib/config.d.ts +2 -2
  2. package/dist/commonjs/lib/config.js +2 -2
  3. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +10 -4
  4. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  5. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +2 -0
  6. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  7. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +6 -4
  8. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  9. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  10. package/dist/commonjs/models/components/marketdetail.d.ts +10 -4
  11. package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
  12. package/dist/commonjs/models/components/marketdetail.js +2 -0
  13. package/dist/commonjs/models/components/marketdetail.js.map +1 -1
  14. package/dist/commonjs/models/components/tokenizedassetclass.d.ts +13 -8
  15. package/dist/commonjs/models/components/tokenizedassetclass.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/tokenizedassetclass.js +7 -4
  17. package/dist/commonjs/models/components/tokenizedassetclass.js.map +1 -1
  18. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts +1 -0
  19. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts.map +1 -1
  20. package/dist/commonjs/models/components/tokenizedassetprovider.js +1 -0
  21. package/dist/commonjs/models/components/tokenizedassetprovider.js.map +1 -1
  22. package/dist/esm/lib/config.d.ts +2 -2
  23. package/dist/esm/lib/config.js +2 -2
  24. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +10 -4
  25. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  26. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +2 -0
  27. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  28. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +6 -4
  29. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  30. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  31. package/dist/esm/models/components/marketdetail.d.ts +10 -4
  32. package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
  33. package/dist/esm/models/components/marketdetail.js +2 -0
  34. package/dist/esm/models/components/marketdetail.js.map +1 -1
  35. package/dist/esm/models/components/tokenizedassetclass.d.ts +13 -8
  36. package/dist/esm/models/components/tokenizedassetclass.d.ts.map +1 -1
  37. package/dist/esm/models/components/tokenizedassetclass.js +7 -4
  38. package/dist/esm/models/components/tokenizedassetclass.js.map +1 -1
  39. package/dist/esm/models/components/tokenizedassetprovider.d.ts +1 -0
  40. package/dist/esm/models/components/tokenizedassetprovider.d.ts.map +1 -1
  41. package/dist/esm/models/components/tokenizedassetprovider.js +1 -0
  42. package/dist/esm/models/components/tokenizedassetprovider.js.map +1 -1
  43. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +21 -19
  44. package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md +15 -15
  45. package/docs/models/components/marketdetail.md +33 -31
  46. package/docs/models/components/tokenizedassetclass.md +8 -6
  47. package/docs/models/components/tokenizedassetprovider.md +1 -1
  48. package/openapi_prepped_for_speakeasy.json +23 -3
  49. package/package.json +1 -1
  50. package/src/lib/config.ts +2 -2
  51. package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +12 -4
  52. package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts +6 -4
  53. package/src/models/components/marketdetail.ts +12 -4
  54. package/src/models/components/tokenizedassetclass.ts +13 -8
  55. package/src/models/components/tokenizedassetprovider.ts +1 -0
package/dist/esm/models/components/tokenizedassetclass.js CHANGED
@@ -8,10 +8,12 @@ import * as z from "zod/v3";
8
8
  * @remarks
9
9
  *
10
10
  * `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
11
- * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
12
- * trade via the swap-based `transact/buy` and `transact/sell` endpoints.
13
- * `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
14
- * *asynchronous* redemption request settled off-chain by the vault operator.
11
+ * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and
12
+ * `DERWA` trade via the swap-based `transact/buy` and `transact/sell`
13
+ * endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell
14
+ * is an *asynchronous* redemption request settled off-chain by the vault
15
+ * operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles
16
+ * each buy/sell as a single instant DEX swap.
15
17
  */
16
18
  export const TokenizedAssetClass = {
17
19
  Equity: "EQUITY",
@@ -19,6 +21,7 @@ export const TokenizedAssetClass = {
19
21
  BasisTrade: "BASIS_TRADE",
20
22
  BtcYield: "BTC_YIELD",
21
23
  ManagedVault: "MANAGED_VAULT",
24
+ Derwa: "DERWA",
22
25
  };
23
26
  /** @internal */
24
27
  export const TokenizedAssetClass$inboundSchema = z.nativeEnum(TokenizedAssetClass);
package/dist/esm/models/components/tokenizedassetclass.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"tokenizedassetclass.js","sourceRoot":"","sources":["../../../../src/models/components/tokenizedassetclass.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,SAAS;IACjB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,YAAY,EAAE,eAAe;CACrB,CAAC;AAcX,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAE1C,CAAC,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;AACtC,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAE3C,iCAAiC,CAAC"}
1
+ {"version":3,"file":"tokenizedassetclass.js","sourceRoot":"","sources":["../../../../src/models/components/tokenizedassetclass.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,SAAS;IACjB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,YAAY,EAAE,eAAe;IAC7B,KAAK,EAAE,OAAO;CACN,CAAC;AAgBX,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAE1C,CAAC,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;AACtC,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAE3C,iCAAiC,CAAC"}
package/dist/esm/models/components/tokenizedassetprovider.d.ts CHANGED
@@ -7,6 +7,7 @@ export declare const TokenizedAssetProvider: {
7
7
  readonly Ondo: "ondo";
8
8
  readonly Midas: "midas";
9
9
  readonly Ixs: "ixs";
10
+ readonly Centrifuge: "centrifuge";
10
11
  };
11
12
  /**
12
13
  * Issuer/provider of a tokenized asset.
package/dist/esm/models/components/tokenizedassetprovider.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"tokenizedassetprovider.d.ts","sourceRoot":"","sources":["../../../../src/models/components/tokenizedassetprovider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE/E,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,aAAa,CAChE,OAAO,sBAAsB,CACS,CAAC;AACzC,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,aAAa,CACjE,OAAO,sBAAsB,CACS,CAAC"}
1
+ {"version":3,"file":"tokenizedassetprovider.d.ts","sourceRoot":"","sources":["../../../../src/models/components/tokenizedassetprovider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;CAKzB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE/E,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,aAAa,CAChE,OAAO,sBAAsB,CACS,CAAC;AACzC,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,aAAa,CACjE,OAAO,sBAAsB,CACS,CAAC"}
package/dist/esm/models/components/tokenizedassetprovider.js CHANGED
@@ -9,6 +9,7 @@ export const TokenizedAssetProvider = {
9
9
  Ondo: "ondo",
10
10
  Midas: "midas",
11
11
  Ixs: "ixs",
12
+ Centrifuge: "centrifuge",
12
13
  };
13
14
  /** @internal */
14
15
  export const TokenizedAssetProvider$inboundSchema = z.nativeEnum(TokenizedAssetProvider);
package/dist/esm/models/components/tokenizedassetprovider.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"tokenizedassetprovider.js","sourceRoot":"","sources":["../../../../src/models/components/tokenizedassetprovider.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;CACF,CAAC;AAMX,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAE7C,CAAC,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;AACzC,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAE9C,oCAAoC,CAAC"}
1
+ {"version":3,"file":"tokenizedassetprovider.js","sourceRoot":"","sources":["../../../../src/models/components/tokenizedassetprovider.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,UAAU,EAAE,YAAY;CAChB,CAAC;AAMX,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAE7C,CAAC,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;AACzC,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAE9C,oCAAoC,CAAC"}
package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md CHANGED
@@ -19,27 +19,29 @@ let value: CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
19
19
  provider: "ixs",
20
20
  assetClass: "BASIS_TRADE",
21
21
  chain: "base",
22
+ restrictedJurisdictions: [],
22
23
  };
23
24
  ```
24
25
 
25
26
  ## Fields
26
27
 
27
- | Field | Type | Required | Description | Example |
28
- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
29
- | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
30
- | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
31
- | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
32
- | `contractAddress` | *string* | :heavy_check_mark: | On-chain ERC-20 address for this token, on the network given by `chain`. | |
33
- | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
34
- | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
35
- | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
36
- | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
37
- | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
38
- | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
39
- | `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_check_mark: | Issuer/provider of a tokenized asset. | |
40
- | `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_check_mark: | 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`) and `MANAGED_VAULT`<br/>trade via the swap-based `transact/buy` and `transact/sell` endpoints.<br/>`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an<br/>*asynchronous* redemption request settled off-chain by the vault operator. | |
41
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
42
- | `apy7d` | *string* | :heavy_minus_sign: | Trailing 7-day annualized NAV growth (decimal fraction string, e.g. '0.0512' = 5.12%). RWA yield assets only; null until enough NAV history exists. | |
43
- | `apy30d` | *string* | :heavy_minus_sign: | Trailing 30-day annualized NAV growth (decimal fraction string). RWA yield assets only; null until enough NAV history exists. | |
44
- | `tvlUsd` | *string* | :heavy_minus_sign: | Total value locked in USD (RWA yield assets only). | |
45
- | `status` | [components.TradingStatus](../../models/components/tradingstatus.md) | :heavy_minus_sign: | Live tradability: whether this market can be traded right now, and if not, why (and when it reopens). Equities follow US market sessions (some are 24-7 via an off-hours track); RWA yield / vault assets trade continuously unless the issuer pauses. Null if status is unavailable. | |
28
+ | Field | Type | Required | Description | Example |
29
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30
+ | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
31
+ | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
32
+ | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
33
+ | `contractAddress` | *string* | :heavy_check_mark: | On-chain ERC-20 address for this token, on the network given by `chain`. | |
34
+ | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
35
+ | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
36
+ | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
37
+ | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
38
+ | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
39
+ | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
40
+ | `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_check_mark: | Issuer/provider of a tokenized asset. | |
41
+ | `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_check_mark: | 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`), `MANAGED_VAULT`, and<br/>`DERWA` trade via the swap-based `transact/buy` and `transact/sell`<br/>endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell<br/>is an *asynchronous* redemption request settled off-chain by the vault<br/>operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles<br/>each buy/sell as a single instant DEX swap. | |
42
+ | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
43
+ | `apy7d` | *string* | :heavy_minus_sign: | Trailing 7-day annualized NAV growth (decimal fraction string, e.g. '0.0512' = 5.12%). RWA yield assets only; null until enough NAV history exists. | |
44
+ | `apy30d` | *string* | :heavy_minus_sign: | Trailing 30-day annualized NAV growth (decimal fraction string). RWA yield assets only; null until enough NAV history exists. | |
45
+ | `tvlUsd` | *string* | :heavy_minus_sign: | Total value locked in USD (RWA yield assets only). | |
46
+ | `status` | [components.TradingStatus](../../models/components/tradingstatus.md) | :heavy_minus_sign: | Live tradability: whether this market can be traded right now, and if not, why (and when it reopens). Equities follow US market sessions (some are 24-7 via an off-hours track); RWA yield / vault assets trade continuously unless the issuer pauses. Null if status is unavailable. | |
47
+ | `restrictedJurisdictions` | *string*[] | :heavy_minus_sign: | ISO country codes where this asset must not be offered (e.g. ['US']). Regulation-S instruments (Centrifuge deRWA) restrict US persons; the API surfaces the restriction for integrators to enforce — it does not itself geo-gate. Empty for unrestricted assets (Ondo/Midas/IXS). | [] |
package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md CHANGED
@@ -21,18 +21,18 @@ let value:
21
21
 
22
22
  ## Fields
23
23
 
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`) and `MANAGED_VAULT`<br/>trade via the swap-based `transact/buy` and `transact/sell` endpoints.<br/>`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an<br/>*asynchronous* redemption request settled off-chain by the vault operator. | |
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. | [] |
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`), `MANAGED_VAULT`, and<br/>`DERWA` trade via the swap-based `transact/buy` and `transact/sell`<br/>endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell<br/>is an *asynchronous* redemption request settled off-chain by the vault<br/>operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles<br/>each buy/sell as a single instant DEX swap. | |
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. | [] |