Skip to content

Commit 3a9a5ab

Browse files
committed
Update DeFi Positions docs to indicate coming soon status
The DeFi Positions endpoint is temporarily unavailable while being rearchitected for expanded protocol coverage. Updated documentation to reflect this status: - Added prominent warning banner on main docs page - Updated OpenAPI spec title and descriptions - Added "Coming Soon" indicator to compute units table - Changed present tense to future tense in descriptions
1 parent 08dc998 commit 3a9a5ab

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

compute-units.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Compute Units (CUs) are how we measure API usage in Sim. CUs reflect the actual
1313
| Balances (EVM & SVM) | Chain-dependent | N compute units, where N is the number of chains processed in the `chain_ids` query parameter after tag expansion | {<DefaultChainCount endpoint="balances" />} |
1414
| Balances (single token sub-path) | Fixed | 1 compute unit per request. Accepts exactly one `chain_ids` value (single chain only) | - |
1515
| Collectibles | Chain-dependent | N compute units, where N is the number of chains processed in the `chain_ids` query parameter after tag expansion | {<DefaultChainCount endpoint="collectibles" />} |
16-
| DeFi Positions | Chain-dependent | 2N compute units, where N is the number of chains processed in the `chain_ids` query parameter after tag expansion ||
16+
| DeFi Positions *(Coming Soon)* | Chain-dependent | 2N compute units, where N is the number of chains processed in the `chain_ids` query parameter after tag expansion ||
1717
| Activity | Fixed | 3 compute units per request ||
1818
| Transactions (EVM & SVM) | Fixed | 1 compute unit per request ||
1919
| Token Info | Fixed | 2 compute units per request, even though `chain_ids` is required ||

evm/defi-positions.mdx

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,22 @@ sidebarTitle: "DeFi Positions"
77

88
import { SupportedChains } from '/snippets/supported-chains.mdx';
99

10-
![Defi Positions API](/images/evm/defi-positions.svg)
10+
<Warning>
11+
**Coming Soon: This endpoint is temporarily unavailable**
12+
13+
The DeFi Positions endpoint is currently being rearchitected to provide expanded protocol coverage and enhanced functionality. We're working to bring it back with improved support for more DeFi protocols and chains.
1114

12-
The DeFi Positions API returns a wallet's active positions across liquidity pools, lending protocols, yield strategies, and tokenized DeFi assets.
13-
Each position includes token holdings, USD valuations, underlying asset metadata, and protocol-specific details such as tick ranges, collateral status, or reward accruals.
15+
Please check back soon for updates on availability.
16+
</Warning>
17+
18+
![Defi Positions API](/images/evm/defi-positions.svg)
1419

15-
<SupportedChains endpoint="defi_positions" />
20+
The DeFi Positions API will return a wallet's active positions across liquidity pools, lending protocols, yield strategies, and tokenized DeFi assets.
21+
Each position will include token holdings, USD valuations, underlying asset metadata, and protocol-specific details such as tick ranges, collateral status, or reward accruals.
1622

1723
<Note>
18-
This endpoint is currently available at the beta path (`/beta/evm/defi/positions`).
19-
Schemas are stable, but response fields may expand as we onboard new protocols.
24+
When available, this endpoint will be accessible at the beta path (`/beta/evm/defi/positions`).
25+
The information below represents the planned functionality and supported protocols for the rearchitected endpoint.
2026
</Note>
2127

2228
## Supported Protocols

evm/openapi/defi-positions.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.3",
33
"info": {
44
"title": "Sim API - DeFi Positions Endpoint",
5-
"description": "Retrieve DeFi positions along with pricing and metadata for an address across supported EVM chains.",
5+
"description": "⚠️ **Coming Soon**: This endpoint is temporarily unavailable while being rearchitected for expanded coverage. The DeFi Positions API will retrieve DeFi positions along with pricing and metadata for an address across supported EVM chains.",
66
"license": {
77
"name": ""
88
},
@@ -19,8 +19,8 @@
1919
"tags": [
2020
"defi-positions"
2121
],
22-
"summary": "Get DeFi positions for an address",
23-
"description": "Returns a wallet's DeFi positions including USD values, position-specific metadata, and aggregation summaries across supported protocols.",
22+
"summary": "Get DeFi positions for an address (Coming Soon)",
23+
"description": "⚠️ **This endpoint is temporarily unavailable** while being rearchitected for expanded coverage. When available, it will return a wallet's DeFi positions including USD values, position-specific metadata, and aggregation summaries across supported protocols.",
2424
"operationId": "getEvmDefiPositions",
2525
"parameters": [
2626
{

0 commit comments

Comments
 (0)