@compass-labs/api-sdk 2.2.88-rc.0 → 2.2.89-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.
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
@@ -16,9 +16,10 @@ let value: MarketDetail = {
16
16
  currentPriceUsd: "<value>",
17
17
  sectors: [],
18
18
  regionExposure: [],
19
- provider: "ixs",
19
+ provider: "centrifuge",
20
20
  assetClass: "MANAGED_VAULT",
21
21
  chain: "arbitrum",
22
+ restrictedJurisdictions: [],
22
23
  priceHistory24h: [],
23
24
  tradableSessions: [],
24
25
  };
@@ -26,33 +27,34 @@ let value: MarketDetail = {
26
27
 
27
28
  ## Fields
28
29
 
29
- | Field | Type | Required | Description | Example |
30
- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
31
- | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
32
- | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
33
- | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
34
- | `contractAddress` | *string* | :heavy_check_mark: | On-chain ERC-20 address for this token, on the network given by `chain`. | |
35
- | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
36
- | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
37
- | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
38
- | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
39
- | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
40
- | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
41
- | `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_check_mark: | Issuer/provider of a tokenized asset. | |
42
- | `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. | |
43
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
44
- | `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. | |
45
- | `apy30d` | *string* | :heavy_minus_sign: | Trailing 30-day annualized NAV growth (decimal fraction string). RWA yield assets only; null until enough NAV history exists. | |
46
- | `tvlUsd` | *string* | :heavy_minus_sign: | Total value locked in USD (RWA yield assets only). | |
47
- | `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. | |
48
- | `priceHistory24h` | [components.PricePoint](../../models/components/pricepoint.md)[] | :heavy_minus_sign: | 24h price sparkline as `(timestamp, price)` samples in chronological order. | [] |
49
- | `priceHigh52w` | *string* | :heavy_minus_sign: | 52-week high of the underlying equity (USD). | |
50
- | `priceLow52w` | *string* | :heavy_minus_sign: | 52-week low of the underlying equity (USD). | |
51
- | `volume24h` | *string* | :heavy_minus_sign: | 24h trading volume of the underlying equity. | |
52
- | `averageVolume` | *string* | :heavy_minus_sign: | Average trading volume of the underlying equity. | |
53
- | `sharesOutstanding` | *string* | :heavy_minus_sign: | Shares outstanding of the underlying equity. | |
54
- | `marketCap` | *string* | :heavy_minus_sign: | Market cap of the underlying equity (USD). | |
55
- | `totalHolders` | *number* | :heavy_minus_sign: | On-chain holder count for the tokenized equity. | |
56
- | `tradableSessions` | *string*[] | :heavy_minus_sign: | Sessions in which the token can be traded (e.g. 'regular', 'premarket'). | [] |
57
- | `sharesMultiplier` | *string* | :heavy_minus_sign: | Shares-multiplier ratio (= 1 if no recent split / corporate action). | |
58
- | `candles` | [components.OhlcCandle](../../models/components/ohlccandle.md)[] | :heavy_minus_sign: | OHLC candles. Present only when both `interval` and `range` query params are provided and form a valid pair; omitted otherwise. | |
30
+ | Field | Type | Required | Description | Example |
31
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32
+ | `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
33
+ | `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
34
+ | `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
35
+ | `contractAddress` | *string* | :heavy_check_mark: | On-chain ERC-20 address for this token, on the network given by `chain`. | |
36
+ | `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
37
+ | `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
38
+ | `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
39
+ | `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
40
+ | `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
41
+ | `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
42
+ | `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_check_mark: | Issuer/provider of a tokenized asset. | |
43
+ | `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. | |
44
+ | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
45
+ | `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. | |
46
+ | `apy30d` | *string* | :heavy_minus_sign: | Trailing 30-day annualized NAV growth (decimal fraction string). RWA yield assets only; null until enough NAV history exists. | |
47
+ | `tvlUsd` | *string* | :heavy_minus_sign: | Total value locked in USD (RWA yield assets only). | |
48
+ | `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. | |
49
+ | `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). | [] |
50
+ | `priceHistory24h` | [components.PricePoint](../../models/components/pricepoint.md)[] | :heavy_minus_sign: | 24h price sparkline as `(timestamp, price)` samples in chronological order. | [] |
51
+ | `priceHigh52w` | *string* | :heavy_minus_sign: | 52-week high of the underlying equity (USD). | |
52
+ | `priceLow52w` | *string* | :heavy_minus_sign: | 52-week low of the underlying equity (USD). | |
53
+ | `volume24h` | *string* | :heavy_minus_sign: | 24h trading volume of the underlying equity. | |
54
+ | `averageVolume` | *string* | :heavy_minus_sign: | Average trading volume of the underlying equity. | |
55
+ | `sharesOutstanding` | *string* | :heavy_minus_sign: | Shares outstanding of the underlying equity. | |
56
+ | `marketCap` | *string* | :heavy_minus_sign: | Market cap of the underlying equity (USD). | |
57
+ | `totalHolders` | *number* | :heavy_minus_sign: | On-chain holder count for the tokenized equity. | |
58
+ | `tradableSessions` | *string*[] | :heavy_minus_sign: | Sessions in which the token can be traded (e.g. 'regular', 'premarket'). | [] |
59
+ | `sharesMultiplier` | *string* | :heavy_minus_sign: | Shares-multiplier ratio (= 1 if no recent split / corporate action). | |
60
+ | `candles` | [components.OhlcCandle](../../models/components/ohlccandle.md)[] | :heavy_minus_sign: | OHLC candles. Present only when both `interval` and `range` query params are provided and form a valid pair; omitted otherwise. | |
@@ -3,21 +3,23 @@
3
3
  Asset class of a tokenized asset.
4
4
 
5
5
  `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
6
- yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
7
- trade via the swap-based `transact/buy` and `transact/sell` endpoints.
8
- `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
9
- *asynchronous* redemption request settled off-chain by the vault operator.
6
+ yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and
7
+ `DERWA` trade via the swap-based `transact/buy` and `transact/sell`
8
+ endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell
9
+ is an *asynchronous* redemption request settled off-chain by the vault
10
+ operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles
11
+ each buy/sell as a single instant DEX swap.
10
12
 
11
13
  ## Example Usage
12
14
 
13
15
  ```typescript
14
16
  import { TokenizedAssetClass } from "@compass-labs/api-sdk/models/components";
15
17
 
16
- let value: TokenizedAssetClass = "MANAGED_VAULT";
18
+ let value: TokenizedAssetClass = "DERWA";
17
19
  ```
18
20
 
19
21
  ## Values
20
22
 
21
23
  ```typescript
22
- "EQUITY" | "T_BILLS" | "BASIS_TRADE" | "BTC_YIELD" | "MANAGED_VAULT"
24
+ "EQUITY" | "T_BILLS" | "BASIS_TRADE" | "BTC_YIELD" | "MANAGED_VAULT" | "DERWA"
23
25
  ```
@@ -13,5 +13,5 @@ let value: TokenizedAssetProvider = "midas";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "ondo" | "midas" | "ixs"
16
+ "ondo" | "midas" | "ixs" | "centrifuge"
17
17
  ```
@@ -18557,6 +18557,15 @@
18557
18557
  ],
18558
18558
  "description": "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."
18559
18559
  },
18560
+ "restricted_jurisdictions": {
18561
+ "items": {
18562
+ "type": "string"
18563
+ },
18564
+ "type": "array",
18565
+ "title": "Restricted Jurisdictions",
18566
+ "description": "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 \u2014 it does not itself geo-gate. Empty for unrestricted assets (Ondo/Midas/IXS).",
18567
+ "example": []
18568
+ },
18560
18569
  "price_history_24h": {
18561
18570
  "items": {
18562
18571
  "$ref": "#/components/schemas/PricePoint"
@@ -25252,17 +25261,19 @@
25252
25261
  "T_BILLS",
25253
25262
  "BASIS_TRADE",
25254
25263
  "BTC_YIELD",
25255
- "MANAGED_VAULT"
25264
+ "MANAGED_VAULT",
25265
+ "DERWA"
25256
25266
  ],
25257
25267
  "title": "TokenizedAssetClass",
25258
- "description": "Asset class of a tokenized asset.\n\n`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA\nyield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`\ntrade via the swap-based `transact/buy` and `transact/sell` endpoints.\n`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an\n*asynchronous* redemption request settled off-chain by the vault operator."
25268
+ "description": "Asset class of a tokenized asset.\n\n`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA\nyield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and\n`DERWA` trade via the swap-based `transact/buy` and `transact/sell`\nendpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell\nis an *asynchronous* redemption request settled off-chain by the vault\noperator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles\neach buy/sell as a single instant DEX swap."
25259
25269
  },
25260
25270
  "TokenizedAssetProvider": {
25261
25271
  "type": "string",
25262
25272
  "enum": [
25263
25273
  "ondo",
25264
25274
  "midas",
25265
- "ixs"
25275
+ "ixs",
25276
+ "centrifuge"
25266
25277
  ],
25267
25278
  "title": "TokenizedAssetProvider",
25268
25279
  "description": "Issuer/provider of a tokenized asset."
@@ -30501,6 +30512,15 @@
30501
30512
  }
30502
30513
  ],
30503
30514
  "description": "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."
30515
+ },
30516
+ "restricted_jurisdictions": {
30517
+ "items": {
30518
+ "type": "string"
30519
+ },
30520
+ "type": "array",
30521
+ "title": "Restricted Jurisdictions",
30522
+ "description": "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 \u2014 it does not itself geo-gate. Empty for unrestricted assets (Ondo/Midas/IXS).",
30523
+ "example": []
30504
30524
  }
30505
30525
  },
30506
30526
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.88-rc.0",
3
+ "version": "2.2.89-rc.0",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {
package/src/lib/config.ts CHANGED
@@ -62,7 +62,7 @@ export const SDK_METADATA = {
62
62
  language: "typescript",
63
63
  openapiDocVersion: "0.0.1",
64
64
  sdkVersion: "2.0.0",
65
- genVersion: "2.917.0",
65
+ genVersion: "2.918.3",
66
66
  userAgent:
67
- "speakeasy-sdk/typescript 2.0.0 2.917.0 0.0.1 @compass-labs/api-sdk",
67
+ "speakeasy-sdk/typescript 2.0.0 2.918.3 0.0.1 @compass-labs/api-sdk",
68
68
  } as const;
@@ -72,10 +72,12 @@ export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
72
72
  * @remarks
73
73
  *
74
74
  * `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
75
- * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
76
- * trade via the swap-based `transact/buy` and `transact/sell` endpoints.
77
- * `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
78
- * *asynchronous* redemption request settled off-chain by the vault operator.
75
+ * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and
76
+ * `DERWA` trade via the swap-based `transact/buy` and `transact/sell`
77
+ * endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell
78
+ * is an *asynchronous* redemption request settled off-chain by the vault
79
+ * operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles
80
+ * each buy/sell as a single instant DEX swap.
79
81
  */
80
82
  assetClass: TokenizedAssetClass;
81
83
  /**
@@ -98,6 +100,10 @@ export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
98
100
  * 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.
99
101
  */
100
102
  status?: TradingStatus | null | undefined;
103
+ /**
104
+ * 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).
105
+ */
106
+ restrictedJurisdictions?: Array<string> | undefined;
101
107
  };
102
108
 
103
109
  /** @internal */
@@ -124,6 +130,7 @@ export const CompassApiBackendV2ModelsTokenizedAssetsMarketMarket$inboundSchema:
124
130
  apy_30d: z.nullable(z.string()).optional(),
125
131
  tvl_usd: z.nullable(z.string()).optional(),
126
132
  status: z.nullable(TradingStatus$inboundSchema).optional(),
133
+ restricted_jurisdictions: z.array(z.string()).optional(),
127
134
  }).transform((v) => {
128
135
  return remap$(v, {
129
136
  "underlying_ticker": "underlyingTicker",
@@ -136,6 +143,7 @@ export const CompassApiBackendV2ModelsTokenizedAssetsMarketMarket$inboundSchema:
136
143
  "apy_7d": "apy7d",
137
144
  "apy_30d": "apy30d",
138
145
  "tvl_usd": "tvlUsd",
146
+ "restricted_jurisdictions": "restrictedJurisdictions",
139
147
  });
140
148
  });
141
149
 
@@ -72,10 +72,12 @@ export type CompassApiBackendV2ModelsTokenizedAssetsReadResponsePositionsPositio
72
72
  * @remarks
73
73
  *
74
74
  * `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
75
- * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
76
- * trade via the swap-based `transact/buy` and `transact/sell` endpoints.
77
- * `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
78
- * *asynchronous* redemption request settled off-chain by the vault operator.
75
+ * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and
76
+ * `DERWA` trade via the swap-based `transact/buy` and `transact/sell`
77
+ * endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell
78
+ * is an *asynchronous* redemption request settled off-chain by the vault
79
+ * operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles
80
+ * each buy/sell as a single instant DEX swap.
79
81
  */
80
82
  assetClass?: TokenizedAssetClass | undefined;
81
83
  /**