# Cielo Public API > Programmatic access to the on-chain data that powers Cielo Finance — the wallet activity feed, wallet PnL and trading stats, token metadata, prices and safety checks, wallet tags and related wallets, portfolio tracking, and on-chain trading. Authenticate with an API key sent in the X-API-KEY header. Each endpoint notes its credit cost and the plans it is available on. - Base URL: `https://api.cielo.finance` - OpenAPI spec: `https://api.cielo.finance/swagger/openapi.json` - Swagger UI: https://api.cielo.finance/swagger - Developer guides: https://docs.cielo.finance/developer-api/getting-started - Product docs: https://docs.cielo.finance - Endpoint index: https://api.cielo.finance/llms.txt ## Authentication Every request must carry an API key in the `X-API-KEY` header. Manage keys from the Cielo app. --- # Endpoints ## Feed ### GET /api/v1/feed **Feed** Reference: https://docs.cielo.finance/api-reference/feed#get-api-v1-feed This endpoint retrieves a feed of transactions based on specified query parameters. With `includeMarketCap=true` the response also includes the market capitalization of tokens; this doubles the cost of the request. **Filters** - **Wallet Address**: Filter transactions by wallet address. - **Number of Transactions (limit)**: Specify the number of transactions to retrieve. - **Specific Lists**: Filter transactions by specific lists. - **Chains**: Filter transactions by chains. - **Transaction Types**: Filter transactions by transaction types. - **Tokens**: Filter transactions by tokens. - **Minimum USD Value**: Filter transactions by minimum USD value. - **Maximum USD Value**: Filter transactions by maximum USD value. - **Starting Point**: Specify the starting point of the feed. - **New Trades**: Filter transactions by new trades. **Supported Chains** All chains returned by `/api/v1/chains`: EVM chains, Solana, Hyperliquid, Sui, Tron and Bitcoin. **Cost** - **Cost per request**: 5 credits - **Narrow query**: 3 credits. A query that filters by `chains` or `txTypes` and has exactly one wallet, one chain or one transaction type. - **`includeMarketCap=true`**: doubles the price (10 or 6 credits). **Available Plans** Available on the following plans: - Free - Builder - Architect - Enterprise #### Parameters - `wallet` (query, optional, string) — Filter the feed by a specific wallet address. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `limit` (query, optional, integer) — Limit the number of transactions returned in the feed. The maximum limit is 100. Example: `10`. - `list` (query, optional, integer) — Filter transactions by a specific List ID. Example: `1`. - `chains` (query, optional, array) — Filter transactions by specific blockchain chains (e.g. ethereum), comma-separated for multiple values (e.g. ethereum,polygon). The authoritative live list of supported chains is available at `GET /api/v1/chains` — the `enum` below is a snapshot and may lag behind newly added networks. Example: `[ethereum base arbitrum]`. Values: solana, base, ethereum, abstract, arbitrum, aurora, avalanche, berachain, bitcoin, blast, bnb, gnosis, hyperevm, hyperliquid, ink, linea, mantle, megaeth, monad, optimism, plasma, polygon, pulsechain, robinhood, scroll, sonic, stable, story, sui, tempo, tron, unichain, zksync. - `txTypes` (query, optional, array) — Filter transactions by types (e.g. swap, nft_trade), comma-separated for multiple values (e.g, swap,transfer,nft_trade) Values: bridge, contract_creation, contract_interaction, flashloan, lending, lp, nft_lending, nft_liquidation, nft_mint, nft_sweep, nft_trade, nft_transfer, option, perp, reward, staking, sudo_pool, swap, transfer, wrap. - `tokens` (query, optional, array) — Filter transactions by specific tokens, identified by either their address or symbol , comma-separated for multiple values (e.g, LINK,BITCOIN) - `minUSD` (query, optional, number) — Set a minimum USD value for transactions. Default - 0 Example: `100`. - `maxUSD` (query, optional, number) — Set a maximum USD value for transactions. Default - 0 Example: `1000`. - `newTrades` (query, optional, boolean) — Filter transactions by new trades. Example: `true`. - `startFrom` (query, optional, string) — Set value from response 'paging.next_object_id' to get next page. Example: `NjUyZDFlOTZjYTU1MTNjM2M0NzAyMjk5XzE2OTc0NTU3NjM`. - `fromTimestamp` (query, optional, integer) — Filter transactions from a specific UNIX timestamp. Example: `1.63e+12`. - `toTimestamp` (query, optional, integer) — Filter transactions to a specific UNIX timestamp. Example: `1.63e+12`. - `includeMarketCap` (query, optional, boolean) — Include market capitalization of tokens in the response. Doubles the cost of the request. Example: `true`. #### Responses - `200` — - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ## Web Socket ### GET /api/v1/ws **WebSocket Connection** Reference: https://docs.cielo.finance/api-reference/websocket#get-api-v1-ws This endpoint sets up a WebSocket connection to receive updates on new transactions. Once connected, the client can send command messages to the WebSocket in the following formats: **Subscribe to a feed:** Refer to the `FeedSubscribeCommand` schema for the command structure. **Subscribe to all feed events:** ```json { "type": "subscribe_feed", } ``` **Subscribe to feed with filters. Filters tx_types, chains, tokens, min_usd_value, new_trade are optional:** ```json { "type": "subscribe_feed", "filter": { "tx_types": ["transfer", "swap"], "chains": ["eth", "bsc"], "tokens": ["0x1234", "0x5678"], "min_usd_value": 1000, "new_trade": true } } ``` **Subscribe to feed for an new trades:** ```json { "type": "subscribe_feed", "filter": { "new_trade": true } } ``` **Subscribe to feed for a certain list:** ```json { "type": "subscribe_feed", "list_id": 12345 } ``` **Unsubscribe from a feed:** Refer to the `FeedUnsubscribeCommand` schema for the command structure. ```json { "type": "unsubscribe_feed" } ``` **Subscribe to a wallet:** Refer to the `WalletSubscribeCommand` schema for the command structure. **Subscribe to all wallet events:** ```json { "type": "subscribe_wallet", "wallet": "wallet-address", } ``` **Subscribe to wallet events with filters. Filters tx_types, chains, tokens, min_usd_value, new_trade are optional:** ```json { "type": "subscribe_wallet", "wallet": "wallet-address", "filter": { "tx_types": ["transfer", "swap"], "chains": ["ethereum", "bsc"], "tokens": ["0x1234", "0x5678"], "min_usd_value": 1000, "new_trade": true } } ``` **Unsubscribe from a wallet:** Refer to the `WalletUnsubscribeCommand` schema for the command structure. ```json { "type": "unsubscribe_wallet", "wallet": "wallet-address" } ``` The server will send back messages in the following schema: **Websocket Event Message:** Refer to the `WebsocketEvent` schema for the message structure. ```json { "type": "event_type", "data": {} } ``` **Supported Chains** The `chains` filter accepts the same chain identifiers used by the REST API. The authoritative live list is available at `GET /api/v1/chains` — any value not in that list will be rejected by the server when the command is validated. **Pricing Information** Every 10 messages sent over the WebSocket connection consume 1 credit. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Responses - `101` — Switching Protocols - The server has switched protocols in response to a client request. - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ## Wallet ### GET /api/v1/wallet/positions **Wallet Token Positions** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-positions This endpoint retrieves per-token trading positions for one or more wallets: amounts bought and sold, current holdings, average buy and sell prices, and realized and unrealized PnL in USD and in the chain's native token. Results are paginated with a cursor: pass `paging.next_cursor` from the previous response as `next_cursor`. **Cost per Request** Cost per request = 3 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `chain` (query, required, string) — Chain to query. `all` returns positions from both Base and Solana. Example: `solana`. Values: base, solana, all. - `wallets` (query, optional, string) — Comma-separated wallet addresses. Example: `9W7CCnAvviXzP9ToyfCBT4aYbn845HdZSWS7kZPZ96mg`. - `token_addresses` (query, optional, string) — Comma-separated token addresses to filter by. - `active_positions` (query, optional, boolean) — Return only positions with a non-zero holding. Example: `true`. - `collateral` (query, optional, string) — Filter by the collateral the position was traded against. - `sort_by` (query, optional, string) — Sort order. Example: `holding_usd_desc`. Values: bought_usd_asc, bought_usd_desc, bought_native_asc, bought_native_desc, sold_usd_asc, sold_usd_desc, sold_native_asc, sold_native_desc, holding_usd_asc, holding_usd_desc, holding_native_asc, holding_native_desc, realized_profit_usd_asc, realized_profit_usd_desc, realized_profit_native_asc, realized_profit_native_desc, avg_buy_price_usd_asc, avg_buy_price_usd_desc, avg_buy_price_native_asc, avg_buy_price_native_desc, avg_sell_price_usd_asc, avg_sell_price_usd_desc, avg_sell_price_native_asc, avg_sell_price_native_desc, last_trade_timestamp_asc, last_trade_timestamp_desc. - `limit` (query, optional, integer) — Maximum number of positions to return. Example: `50`. - `next_cursor` (query, optional, string) — Cursor from the previous response's `paging.next_cursor`. #### Responses - `200` — OK (schema `WalletTokenPositionsResponse`) - `400` — Bad Request - `chain` is missing or invalid, or `sort_by` is invalid. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `408` — Request Timeout (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/enhanced-stats/aggregated **Enhanced Aggregated Stats** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-enhanced-stats-aggregated This endpoint retrieves enhanced aggregated trading statistics for a specified wallet, including trade counts, buy/sell amounts, DEX distribution, holding times, and most traded tokens. **Cost per Request** Cost per request = 20 credits. **Available Plans** Available on the following plans: - Whale - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — The wallet address to get enhanced aggregated stats for. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `days` (query, optional, string) — Time range filter. Supported options - 1d, 7d, 30d and max. Example: `7d`. - `from_timestamp` (query, optional, integer) — Unix timestamp for the start of the time range. Example: `1.7e+09`. - `to_timestamp` (query, optional, integer) — Unix timestamp for the end of the time range. Example: `1.71e+09`. #### Responses - `200` — OK - `400` — Bad Request - Invalid wallet address or query parameters. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/enhanced-stats/profitability-performance **Profitability & Performance Stats** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-enhanced-stats-profitability-performance This endpoint retrieves profitability and performance statistics for a specified wallet, including win/loss trades, win rate, max profit/drawdown, win streaks, and holding distribution. **Cost per Request** Cost per request = 20 credits. **Available Plans** Available on the following plans: - Whale - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — The wallet address to get profitability stats for. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `days` (query, optional, string) — Time range filter. Supported options - 1d, 7d, 30d and max. Example: `7d`. - `from_timestamp` (query, optional, integer) — Unix timestamp for the start of the time range. Example: `1.7e+09`. - `to_timestamp` (query, optional, integer) — Unix timestamp for the end of the time range. Example: `1.71e+09`. #### Responses - `200` — OK - `400` — Bad Request - Invalid wallet address or query parameters. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/pnl/month **Monthly PnL** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-pnl-month This endpoint retrieves monthly PnL data for a specified wallet, showing profit/loss aggregated by month. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Whale - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — The wallet address to get monthly PnL data for. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. #### Responses - `200` — OK - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - Invalid wallet address or query parameters. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/pnl/nfts **NFT PNL** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-pnl-nfts This endpoint retrieves the PnL value for an NFT collection on Ethereum. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get NFT P&L values for wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `timeframe` (query, optional, string) — Set time range for filtering data. Supported options - 1d, 7d, 30d and max. Default - max timeframe. Example: `5d`. - `next_object` (query, optional, string) — Next page for pagination. Example: `4`. #### Responses - `200` — - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/pnl/tokens **Token PNL** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-pnl-tokens This endpoint retrieves a PnL values for a specified wallet by different tokens. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get P&L values for wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `chain` (query, optional, array) — Filter data by specific blockchain chains (e.g. ethereum), comma-separated for multiple values (e.g, ethereum,polygon) Example: `[ethereum base arbitrum]`. - `timeframe` (query, optional, string) — Set time range for filtering data. Supported options - 1d, 7d, 30d and max. Default - max timeframe. Example: `5d`. - `next_object` (query, optional, string) — Next page for pagination. Example: `4`. - `token` (query, optional, array) — Filter data by specific tokens (e.g. PEPECAT or FfhArvgv8WB7eZ6qwENMouJRzcVpQVDoDtTuHrCk4Cxi), comma-separated for multiple values (e.g, usdc,usdt). Symbols are matched case-insensitively; addresses are matched as-is. Example: `[PEPECAT FfhArvgv8WB7eZ6qwENMouJRzcVpQVDoDtTuHrCk4Cxi]`. - `cex_transfers` (query, optional, boolean) — Include cex transfers for calculating P&L. Default - false. Example: `true`. - `active_positions_only` (query, optional, boolean) — Filter to show only active positions. Default - false. Example: `true`. #### Responses - `200` — - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/pnl/tokens-chart **PnL Tokens Chart** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-pnl-tokens-chart This endpoint retrieves PnL time series chart data for a specified wallet, showing profit/loss over time with ROI calculations. **Cost per Request** Cost per request = 15 credits. **Available Plans** Available on the following plans: - Whale - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — The wallet address to get PnL chart data for. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. #### Responses - `200` — OK - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - Invalid wallet address or query parameters. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/pnl/total-stats **Aggregated Token PNL** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-pnl-total-stats This endpoint retrieves aggregated PnL stats for a specified wallet. **Cost per Request** Cost per request = 20 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get tags associated with wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `chains` (query, optional, array) — Filter transactions by specific blockchain chains (e.g. ethereum), comma-separated for multiple values (e.g, ethereum,polygon) Example: `[ethereum base arbitrum]`. - `timeframe` (query, optional, string) — Set time range for filtering data. Supported options - 1d, 7d, 30d and max. Default - max timeframe. Example: `7d`. - `cex_transfers` (query, optional, boolean) — Include CEX transfers in the response. Example: `true`. #### Responses - `200` — - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/portfolio **Wallet Portfolio** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-portfolio Retrieve the portfolio of a wallet. For Solana wallets, the response also includes the native SOL balance. Portfolio assets with a total_usd_value of zero are not included in the response. Available chains: - Solana - EVM (Ethereum, Base, HyperEVM, Robinhood) **Cost per Request** Cost per request = 20 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get portfolio for wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. #### Responses - `200` — OK (schema `WalletPortfolioResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/related-wallets **Related Wallets** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-related-wallets This endpoint retrieves a list of wallets related to the specified wallet address. Related wallets are determined based on shared activity, such as token transfers, NFT trades, or participation in DeFi protocols. **Cost per Request** Cost per request = 10 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get related wallets for wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `sort_criteria` (query, optional, string) — Sort wallets by the specified criteria. Volume uses total USD received plus sent. Example: `inflow_asc`. Values: volume_asc, volume_desc, inflow_asc, inflow_desc, outflow_asc, outflow_desc, transactions_asc, transactions_desc. #### Responses - `200` — - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/token-balance **Token Balance** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-token-balance Retrieve the token balance for a wallet. Available chains: - Solana - EVM (Ethereum, Base, HyperEVM, Robinhood) **Cost per Request** Cost per request = 3 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get token balance for wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `token_address` (query, required, string) — The token address to get balance for. Example: `0x6B175474E89094C44Da98b954EedeAC495271d0F`. - `chain` (query, required, string) — The blockchain network (ethereum, base, or solana). Example: `solana`. Values: solana, ethereum, base, hyperevm, robinhood, arc. #### Responses - `200` — OK (schema `TokenBalanceResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/trading-stats **Trading Stats** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v1-wallet-trading-stats Detailed performance statistics for a wallet's trading activity, including PnL, ROI, win rate, and trading behavior insights. **Cost per Request** Cost per request = 30 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get trading stats for wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `days` (query, optional, string) — Time period for trading stats (1d, 7d, 30d, max). Example: `7d`. Values: 1d, 7d, 30d, max. #### Responses - `200` — - `202` — Accepted - Data is not ready yet. Retry in 10 seconds. (schema `ErrorResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v2/enhanced-stats/aggregated **Enhanced Aggregated Stats V2** Reference: https://docs.cielo.finance/api-reference/wallet-pnl-and-stats#get-api-v2-enhanced-stats-aggregated This endpoint retrieves enhanced aggregated trading statistics with support for multi-bundle wallets via the multi_bundle_id parameter. **Cost per Request** Cost per request = 25 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (query, optional, string) — The wallet address to get enhanced aggregated stats for. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. - `multi_bundle_id` (query, optional, integer) — Multi-bundle ID to aggregate stats across multiple wallets. Example: `123`. - `days` (query, optional, string) — Time range filter. Supported options - 1d, 7d, 30d and max. Example: `7d`. - `from_timestamp` (query, optional, integer) — Unix timestamp for the start of the time range. Example: `1.7e+09`. - `to_timestamp` (query, optional, integer) — Unix timestamp for the end of the time range. Example: `1.71e+09`. #### Responses - `200` — OK - `400` — Bad Request - Invalid parameters. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ## Tags ### GET /api/v1/tags **Wallets Tags** Reference: https://docs.cielo.finance/api-reference/tags#get-api-v1-tags This endpoint retrieves tags associated with a specific wallet address. Tags provide insights into wallet activity. Note, tags will only be returned for wallets indexed by the Cielo engine. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (query, required, array) — Get tags associated with wallets in the list. Maximum of 50 wallets. Example: `[0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2]`. #### Responses - `200` — Successfull Wallets Tags response (schema `WalletsTags`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/tags/wallets **Wallets by Tag** Reference: https://docs.cielo.finance/api-reference/tags#get-api-v1-tags-wallets This endpoint retrieves wallets associated with a specific tag. Tags provide insights into wallet activity. **Cost per Request** Cost per request = 10 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `tags` (query, required, array) — Filter wallets by a specific tag. Example: `[new_wallet flipper honeypot]`. - `wallet_type` (query, optional, string) — Filter wallets by a specific wallet type. Example: `solana`. Values: evm, solana. - `limit` (query, optional, integer) — The number of wallets to return. The default is 20. The maximum value is 50. Example: `10`. - `next_object` (query, optional, string) — Next page for pagination. Example: `4`. #### Responses - `200` — - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/{wallet}/tags **Tags** Reference: https://docs.cielo.finance/api-reference/tags#get-api-v1-wallet-tags **This endpoint is deprecated. Please use the `/api/v1/tags` endpoint instead.** This endpoint retrieves tags associated with a specific wallet address. Tags provide insights into wallet activity, such as NFT trading volume or participation in DeFi protocols. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `wallet` (path, required, string) — Get tags associated with wallet. Example: `0x0f9d76acdbc4417b026f876be1e2042e45f3bcd2`. #### Responses - `200` — - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ## Token ### GET /api/v1/token/checklist **Token checklist** Reference: https://docs.cielo.finance/api-reference/token#get-api-v1-token-checklist This endpoint retrieves safety and distribution checklist data for a specific token. **Cost per Request** Cost per request = 10 credits. **Available Plans:** - Builder - Architect - Enterprise #### Parameters - `chain` (query, required, string) Example: `solana`. Values: solana, ethereum, base, robinhood, arc. - `token_address` (query, required, string) Example: `6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN`. #### Responses - `200` — OK (schema `TokenChecklistResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `404` — Not Found - Token not found. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/token/metadata **Token metadata** Reference: https://docs.cielo.finance/api-reference/token#get-api-v1-token-metadata This endpoint retrieves metadata for a specific token. **Cost per Request** Cost per request = 2 credits. **Available Plans:** - Builder - Architect - Enterprise #### Parameters - `chain` (query, required, string) Example: `solana`. Values: solana, ethereum, base, hyperevm, robinhood, arc. - `token_address` (query, required, string) Example: `6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN`. #### Responses - `200` — OK (schema `TokenMetadataResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `404` — Not Found - Token not found. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/token/price **Token price** Reference: https://docs.cielo.finance/api-reference/token#get-api-v1-token-price This endpoint retrieves price for a specific token. **Cost per Request** Cost per request = 2 credits. **Available Plans:** - Builder - Architect - Enterprise #### Parameters - `chain` (query, required, string) Example: `solana`. Values: solana, ethereum, base, hyperevm, robinhood, arc. - `token_address` (query, required, string) Example: `6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN`. #### Responses - `200` — OK (schema `TokenPriceResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `404` — Not Found - Token not found. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/token/stats **Token stats** Reference: https://docs.cielo.finance/api-reference/token#get-api-v1-token-stats This endpoint retrieves stats of a specified token. **Cost per Request** Cost per request = 10 credits. **Available Plans:** - Builder - Architect - Enterprise #### Parameters - `chain` (query, required, string) Example: `ethereum`. Values: solana, ethereum, base, hyperevm, robinhood, arc. - `token_address` (query, required, string) Example: `6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN`. - `include_liquidity` (query, optional, boolean) — When false, skips the upstream liquidity evaluation to return faster. The liquidity, pools and is_spam fields stay empty in the response. Pair with /api/v1/token/stats-liquidity to fetch the omitted fields separately. Example: `false`. #### Responses - `200` — OK (schema `TokenStatsResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `404` — Not Found - Token not found. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/token/stats-liquidity **Token liquidity slice** Reference: https://docs.cielo.finance/api-reference/token#get-api-v1-token-stats-liquidity Liquidity portion of /api/v1/token/stats. Designed to pair with /api/v1/token/stats?include_liquidity=false so callers can fetch the fast stats payload and the heavier liquidity slice in parallel. **Cost per Request** Cost per request = 10 credits. **Available Plans:** - Builder - Architect - Enterprise #### Parameters - `chain` (query, required, string) Example: `ethereum`. Values: solana, ethereum, base, hyperevm, robinhood, arc. - `token_address` (query, required, string) Example: `6p6xgHyF7AeE6TZkSmFsko444wqoP15icUSqi2jfGiPN`. #### Responses - `200` — OK (schema `TokenStatsLiquidityResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `404` — Not Found - Token not found. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/trending-tokens **Trending tokens** Reference: https://docs.cielo.finance/api-reference/token#get-api-v1-trending-tokens This endpoint retrieves the top trending tokens by unique wallet activity for the specified chain and interval. **Cost per Request** Cost per request = 20 credits. **Available Plans:** - Builder - Architect - Enterprise #### Parameters - `min_pro_traders` (query, optional, integer) — Unsigned 64-bit integer (0 to 18446744073709551615). Inclusive minimum distinct Pro Trader count for the selected interval. Unavailable rows are excluded; min must not exceed max. - `max_pro_traders` (query, optional, integer) — Unsigned 64-bit integer (0 to 18446744073709551615). Inclusive maximum distinct Pro Trader count for the selected interval. Unavailable rows are excluded; min must not exceed max. - `chain` (query, required, string) — The blockchain network to get trending tokens for. Example: `solana`. Values: solana, base, all. - `interval` (query, optional, string) — The time window for trending calculation. Shorter intervals show more recent momentum; longer intervals show sustained trends. Defaults to 1h. Example: `5m`. Values: 1m, 5m, 1h, 6h, 24h. - `limit` (query, optional, integer) — Maximum number of tokens to return. Example: `20`. - `sort_by` (query, optional, string) — Sort order for results. Example: `market_cap_desc`. Values: pro_traders_asc, pro_traders_desc, mindshare_asc, mindshare_desc, market_cap_asc, market_cap_desc, holders_asc, holders_desc, liquidity_asc, liquidity_desc, volume_24h_asc, volume_24h_desc, transactions_asc, transactions_desc, whale_asc, whale_desc, popular_asc, popular_desc, net_flow_asc, net_flow_desc, fresh_wallets_asc, fresh_wallets_desc, avg_buy_asc, avg_buy_desc, price_change_asc, price_change_desc, age_asc, age_desc, bonding_curve_asc, bonding_curve_desc, unique_wallets_asc, unique_wallets_desc. - `next_cursor` (query, optional, string) — Cursor for pagination. - `dex_paid` (query, optional, boolean) — Filter by DEX paid status. - `protocols` (query, optional, array) — Filter by protocols. - `min_market_cap` (query, optional, number) — Minimum market cap filter (USD). - `max_market_cap` (query, optional, number) — Maximum market cap filter (USD). - `min_liquidity` (query, optional, number) — Minimum liquidity filter (USD). - `max_liquidity` (query, optional, number) — Maximum liquidity filter (USD). - `min_volume_24h` (query, optional, number) — Minimum 24h volume filter (USD). - `max_volume_24h` (query, optional, number) — Maximum 24h volume filter (USD). - `min_unique_wallets` (query, optional, integer) — Minimum unique wallets filter. - `max_unique_wallets` (query, optional, integer) — Maximum unique wallets filter. - `min_holders` (query, optional, integer) — Minimum holders filter. - `max_holders` (query, optional, integer) — Maximum holders filter. - `min_transactions` (query, optional, integer) — Minimum transactions filter. - `max_transactions` (query, optional, integer) — Maximum transactions filter. - `min_mindshare` (query, optional, number) — Minimum mindshare filter. - `max_mindshare` (query, optional, number) — Maximum mindshare filter. - `min_price_change` (query, optional, number) — Minimum price change filter. - `max_price_change` (query, optional, number) — Maximum price change filter. - `min_token_age` (query, optional, string) — Minimum token age filter. - `max_token_age` (query, optional, string) — Maximum token age filter. #### Responses - `200` — OK (schema `TrendingTokensResponse`) - `400` — Bad Request - Invalid parameter. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v2/new-token-flows **New Token Flows** Reference: https://docs.cielo.finance/api-reference/token#get-api-v2-new-token-flows Aggregated token flow data for recently created tokens (within the last 24 hours) across your tracked wallets — the wallet list belonging to the account that owns this API key. Includes platform information for Solana tokens. The caller's wallet is derived server-side from the API key — clients do not need to provide it via a header. **Cost per Request** Cost per request = 5 credits. **Available Plans** - Builder - Architect - Enterprise #### Parameters - `last` (query, optional, string) — Time period (1h, 6h, 24h). Default is 24h. Example: `24h`. Values: 1h, 6h, 24h. - `page` (query, optional, integer) — Page number for pagination. Default is 1. Example: `1`. - `list` (query, optional, integer) — Filter by list/bundle ID. Example: `123`. - `chain` (query, optional, array) — Filter by blockchain chain (e.g. solana, ethereum), comma-separated for multiple values. Example: `[solana]`. - `sort_by` (query, optional, string) — Sort field (net_flow_usd, buy_usd, sell_usd, wallets_num, trades_num). Default is net_flow_usd. Example: `net_flow_usd`. Values: net_flow_usd, buy_usd, sell_usd, wallets_num, trades_num. - `order` (query, optional, string) — Sort order (asc, desc). Default is desc. Example: `desc`. Values: asc, desc. #### Responses - `200` — OK - `400` — Bad Request - The request was unacceptable, often due to a missing or invalid parameter. - `401` — Unauthorized - The API key is not associated with a wallet. - `403` — Forbidden - The API key plan does not allow access to this endpoint. - `500` — Internal Server Error - Something went wrong on the server's end. ### GET /api/v2/token-flows **Token Flows V2** Reference: https://docs.cielo.finance/api-reference/token#get-api-v2-token-flows Aggregated token flow data (buys, sells, net flow) across your tracked wallets — the wallet list belonging to the account that owns this API key. Includes platform information for Solana tokens. The caller's wallet is derived server-side from the API key — clients do not need to provide it via a header. **Cost per Request** Cost per request = 5 credits. **Available Plans** - Builder - Architect - Enterprise #### Parameters - `last` (query, optional, string) — Time period (1h, 6h, 24h, 7d, 30d). Default is 24h. Example: `24h`. Values: 1h, 6h, 24h, 7d, 30d. - `page` (query, optional, integer) — Page number for pagination. Default is 1. Example: `1`. - `list` (query, optional, integer) — Filter by list/bundle ID. Example: `123`. - `chain` (query, optional, array) — Filter by blockchain chain (e.g. solana, ethereum), comma-separated for multiple values. Example: `[solana]`. - `sort_by` (query, optional, string) — Sort field (net_flow_usd, buy_usd, sell_usd, wallets_num, trades_num). Default is net_flow_usd. Example: `net_flow_usd`. Values: net_flow_usd, buy_usd, sell_usd, wallets_num, trades_num. - `order` (query, optional, string) — Sort order (asc, desc). Default is desc. Example: `desc`. Values: asc, desc. #### Responses - `200` — OK - `400` — Bad Request - The request was unacceptable, often due to a missing or invalid parameter. - `401` — Unauthorized - The API key is not associated with a wallet. - `403` — Forbidden - The API key plan does not allow access to this endpoint. - `500` — Internal Server Error - Something went wrong on the server's end. ## Chains ### GET /api/v1/chains **Supported Chains** Reference: https://docs.cielo.finance/api-reference/chains#get-api-v1-chains Returns the list of blockchain networks currently supported by the Cielo API. The list is the authoritative source for the `chains` query parameter used across endpoints such as `/api/v1/feed` and the WebSocket `subscribe_feed` / `subscribe_wallet` commands — any value not in this list will be rejected with `400 invalid chain`. **Cost** - **Cost per request**: 0 credits (this endpoint is free; requests are not deducted from your API credit quota) **Available Plans** Available on all plans: - Free - Builder - Architect - Enterprise #### Responses - `200` — OK - Returns the list of supported chain identifiers. (schema `ChainsResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ## Wallet Management ### GET /api/v1/tracked-wallets **Get Tracked Wallets** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/tracked-wallets#get-api-v1-tracked-wallets This endpoint retrieves a list of wallets that are being tracked. Tracked wallets are wallets that are being monitored for activity, such as token transfers, NFT trades, or participation in DeFi protocols. Plans Included = Free, Builder, Architect Cost per request = 5 credits. #### Parameters - `next_object` (query, optional, string) — Next page for pagination. Example: `4`. - `list_id` (query, optional, integer) — The ID of the list to filter by. Example: `123`. #### Responses - `200` — Successfull Get Tracked Wallets response (schema `GetTrackedWallets`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### POST /api/v1/tracked-wallets **Add Tracked Wallet** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/tracked-wallets#post-api-v1-tracked-wallets This endpoint adds a wallet to the list of tracked wallets. Tracked wallets are wallets that are being monitored for activity, such as token transfers, NFT trades, or participation in DeFi protocols. You can optionally configure notification settings including: - Telegram bot assignment for real-time alerts - Discord channel integration - Minimum USD threshold for notifications - Specific transaction types and chains to monitor Plans Included = Free, Builder, Architect Cost per request = 5 credits. #### Request body - Required `application/json` #### Responses - `200` — Successfull Add Tracked Wallets response (schema `AddTrackedWallet`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### DELETE /api/v1/tracked-wallets **Remove Tracked Wallets** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/tracked-wallets#delete-api-v1-tracked-wallets This endpoint removes a wallet from the list of tracked wallets. Tracked wallets are wallets that are being monitored for activity, such as token transfers, NFT trades, or participation in DeFi protocols. Plans Included = Free, Builder, Architect Cost per request = 5 credits. #### Request body - Required `application/json` #### Responses - `200` — Successfull Delete Tracked Wallets response (schema `DeleteTrackedWallets`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/tracked-wallets/address/{wallet} **Get Wallet By Address** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/tracked-wallets#get-api-v1-tracked-wallets-address-wallet This endpoint retrieves a wallet by its address. Plans Included = Free, Builder, Architect Cost per request = 5 credits. #### Parameters - `wallet` (path, required, string) — The address of the wallet to retrieve. Example: `1.0392900530792776e+47`. #### Responses - `200` — Successfull Get Wallet By Address response (schema `GetWalletByAddress`) - `404` — Wallet not found (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ### GET /api/v1/tracked-wallets/telegram-bots **Get Available Telegram Bots** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/tracked-wallets#get-api-v1-tracked-wallets-telegram-bots This endpoint returns a list of all available Telegram bots that can be used for wallet notifications when adding or updating tracked wallets. Only bots that are available (available=true) are included in the response. This includes both enabled and disabled bots. Each bot has a unique ID that should be used in the telegram_bot_id field when configuring wallet notifications. Plans Included = Builder, Architect, Whale Cost per request = 5 credits. #### Responses - `200` — Successful Get Telegram Bots response - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### PUT /api/v1/tracked-wallets/{wallet_id} **Update Tracked Wallet** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/tracked-wallets#put-api-v1-tracked-wallets-wallet_id This endpoint updates a tracked wallet. Tracked wallets are wallets that are being monitored for activity, such as token transfers, NFT trades, or participation in DeFi protocols. Plans Included = Free, Builder, Architect Cost per request = 5 credits. #### Parameters - `wallet_id` (path, required, integer) — The ID of the wallet to update Example: `123`. #### Request body - Required `application/json` #### Responses - `200` — Successfull Update Tracked Wallets response (schema `UpdateTrackedWallet`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### PUT /api/v2/tracked-wallets/{wallet} **Update Tracked Wallet v2** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/tracked-wallets#put-api-v2-tracked-wallets-wallet This endpoint updates a specified tracked wallet. Plans Included = Builder, Architect, Enterprise Cost per request = 5 credits. #### Parameters - `wallet` (path, required, string) — The address of the wallet to update Example: `1.0392900530792776e+47`. #### Request body - Required `application/json` #### Responses - `200` — Successful Update Tracked Wallet response (schema `UpdateTrackedWallet`) - `400` — Bad Request (schema `ErrorResponse`) - `404` — Wallet not found (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ## Lists ### GET /api/v1/lists/ **Get all lists for a user** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/lists#get-api-v1-lists This endpoint retrieves user's wallets lists. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Responses - `200` — OK (schema `GetUserListsResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### POST /api/v1/lists/ **Add a list** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/lists#post-api-v1-lists This endpoint creates a new list for a user. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Request body - Required `application/json` — schema `CreateUserListRequest` #### Responses - `200` — OK (schema `CreateUserListResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### GET /api/v1/lists/all **Get all wallets lists** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/lists#get-api-v1-lists-all This endpoint retrieves public wallets lists. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `follow_only` (query, optional, boolean) — Filter lists by followed status. Example: `true`. - `order` (query, optional, string) — Order lists by creation date. Example: `popular`. Values: popular, new. - `next_object` (query, optional, string) — Next page for pagination. #### Responses - `200` — OK (schema `GetAllWalletsListsResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### PUT /api/v1/lists/{list_id} **Update a list** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/lists#put-api-v1-lists-list_id This endpoint updates a user's list. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `list_id` (path, required, integer) — The ID of the list to update #### Request body - Required `application/json` — schema `UpdateUserListRequest` #### Responses - `200` — OK (schema `UpdateUserListResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### DELETE /api/v1/lists/{list_id} **Delete a list** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/lists#delete-api-v1-lists-list_id This endpoint deletes a user's list. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `list_id` (path, required, integer) — The ID of the list to update - `delete_wallets` (query, optional, boolean) — Delete wallets in the list #### Responses - `200` — OK (schema `DeleteUserListResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ### PUT /api/v1/lists/{list_id}/toggle-follow **Toggle follow a list** Reference: https://docs.cielo.finance/api-reference/wallet-tracking/lists#put-api-v1-lists-list_id-toggle-follow This endpoint toggles follow a list for a user. **Cost per Request** Cost per request = 5 credits. **Available Plans** Available on the following plans: - Builder - Architect - Enterprise #### Parameters - `list_id` (path, required, integer) — The ID of the list to follow #### Responses - `200` — OK (schema `ToggleFollowListResponse`) - `400` — Bad Request - The request was unacceptable, often due to missing a required parameter. (schema `ErrorResponse`) - `403` — Forbidden - The client does not have access rights to the content. (schema `ErrorResponse`) - `500` — Internal Server Error - Something went wrong on the server's end. (schema `ErrorResponse`) ## Trading Wallets ### GET /api/trading/wallets **Get Trading Wallets** Reference: https://docs.cielo.finance/api-reference/trading/trading-wallets#get-api-trading-wallets Returns a list of trading wallets for the authenticated user. Trading wallets are custodial wallets used for executing trades through Cielo's trading infrastructure. Plans Included = Basic, Whale, ApiBasic, Builder, Architect, Enterprise Cost per request = 5 credits. #### Parameters - `chain` (query, required, string) — Blockchain chain filter (e.g. solana, base). - `include_archived` (query, optional, boolean) — Include archived wallets. #### Responses - `200` — List of trading wallets - `400` — Bad request - chain is required (schema `ErrorResponse`) - `403` — Forbidden - Invalid API key or plan (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ### POST /api/trading/wallets **Create Trading Wallet** Reference: https://docs.cielo.finance/api-reference/trading/trading-wallets#post-api-trading-wallets Creates a new trading wallet for the authenticated user on the given chain. Plans Included = Basic, Whale, ApiBasic, Builder, Architect, Enterprise Cost per request = 10 credits. #### Parameters - `chain` (query, optional, string) — Blockchain chain (e.g. solana, base). Defaults to solana. #### Responses - `200` — Created trading wallet - `403` — Forbidden (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ### GET /api/trading/wallets/default **Get Default Trading Wallet** Reference: https://docs.cielo.finance/api-reference/trading/trading-wallets#get-api-trading-wallets-default Returns the default trading wallet for the specified chain. Plans Included = Basic, Whale, ApiBasic, Builder, Architect, Enterprise Cost per request = 5 credits. #### Parameters - `chain` (query, required, string) — Blockchain chain (e.g. solana, base). #### Responses - `200` — Default trading wallet - `400` — Bad request - chain is required (schema `ErrorResponse`) - `403` — Forbidden (schema `ErrorResponse`) - `404` — Default trading wallet not found (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ### PUT /api/trading/wallets/{wallet_id}/default **Set Default Trading Wallet** Reference: https://docs.cielo.finance/api-reference/trading/trading-wallets#put-api-trading-wallets-wallet_id-default Sets a specific trading wallet as the user's default wallet. Plans Included = Basic, Whale, ApiBasic, Builder, Architect, Enterprise Cost per request = 2 credits. #### Parameters - `wallet_id` (path, required, string) — Trading wallet ID. - `chain` (query, optional, string) — Blockchain chain filter. #### Responses - `200` — Wallet set as default - `400` — Bad request - wallet_id is required (schema `ErrorResponse`) - `403` — Forbidden (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ### PUT /api/trading/wallets/{wallet_id}/name **Rename Trading Wallet** Reference: https://docs.cielo.finance/api-reference/trading/trading-wallets#put-api-trading-wallets-wallet_id-name Updates the display name of a trading wallet. Plans Included = Basic, Whale, ApiBasic, Builder, Architect, Enterprise Cost per request = 2 credits. #### Parameters - `wallet_id` (path, required, string) — Trading wallet ID. - `chain` (query, optional, string) — Blockchain chain filter. #### Request body - Required `application/json` #### Responses - `200` — Wallet renamed - `400` — Bad request - invalid wallet_id or name (schema `ErrorResponse`) - `403` — Forbidden (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ## Solana Trading ### GET /api/trading/solana/v2/quote **Get Solana Swap Quote (v2)** Reference: https://docs.cielo.finance/api-reference/trading/solana-trading#get-api-trading-solana-v2-quote Fetches a quote for buying or selling tokens on Solana. For buy: swaps the chosen collateral (SOL or USDC) for the specified token. For sell: swaps the specified token for the chosen collateral (SOL or USDC). Plans Included = Builder, Architect, Enterprise Cost per request = 5 credits. #### Parameters - `type` (query, required, string) — Trade type. Example: `buy`. Values: buy, sell. - `mint` (query, required, string) — Token mint address to buy or sell. Example: `EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v`. - `collateral` (query, optional, string) — Trading collateral asset. "sol" (default) trades against WSOL; "usdc" trades against the canonical Solana USDC mint (EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v). Determines the decimals used for the amount field. Example: `sol`. Values: sol, usdc. - `amount` (query, optional, number) — Human-readable amount in the chosen collateral on buy (1.5 SOL or 1.5 USDC), or in token units on sell. Converted server-side to collateral base units (lamports for SOL, micro-USDC for USDC). Example: `1.5`. - `amount_raw` (query, optional, string) — Raw amount in collateral base units (lamports for SOL, micro-USDC for USDC, or token's smallest unit on sell). Overrides amount if provided. Example: `1500000000`. #### Responses - `200` — Quote retrieved successfully - `400` — Invalid request parameters (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ## Base Trading ### GET /api/trading/base/v2/quote **Get Base Chain Swap Quote** Reference: https://docs.cielo.finance/api-reference/trading/base-trading#get-api-trading-base-v2-quote Fetches a quote for buying or selling tokens on Base chain. Amount is human-readable. Collateral can be "usdc" (default) or "eth". Plans Included = Builder, Architect, Enterprise Cost per request = 5 credits. #### Parameters - `address` (query, required, string) — Token address (EVM format). Example: `0x0b3e328455c4059EEb9e3f84b5543F74E24e7E1b`. - `amount` (query, optional, number) — Human-readable amount. Example: `1`. - `amount_raw` (query, optional, string) — Raw unit amount (overrides amount). - `type` (query, required, string) — Trade type. Example: `buy`. Values: buy, sell. - `collateral` (query, optional, string) — Collateral token used as the payment/receive token. Example: `eth`. Values: usdc, eth. #### Responses - `200` — Quote retrieved successfully - `400` — Invalid request parameters (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) ### POST /api/trading/base/v2/swap **Execute Base Chain Swap** Reference: https://docs.cielo.finance/api-reference/trading/base-trading#post-api-trading-base-v2-swap Executes a token swap on Base chain. Amount is human-readable. Collateral determines which token is used as payment (buy) or received (sell). Slippage is in basis points (50 = 0.5%). Requires both X-API-KEY and Authorization Bearer token. Plans Included = Builder, Architect, Enterprise Cost per request = 1 credit. #### Parameters - `Authorization` (header, required, string) — Bearer token for user authentication. #### Request body - Required `application/json` #### Responses - `200` — Swap executed successfully - `400` — Invalid swap request (schema `ErrorResponse`) - `401` — Unauthorized (schema `ErrorResponse`) - `500` — Internal Server Error (schema `ErrorResponse`) --- ## Schemas ### AddTrackedWallet - `data` (TrackedWallet) - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### Bridge - `amount` (number) — The amount of the token involved in the transaction. - `amount_usd` (number) — The equivalent amount in USD of the tokens involved in the transaction. - `block` (integer) — The block number on the blockchain in which the transaction is included. - `chain` (string) — The blockchain on which the transaction occurred, like 'ethereum'. - `from` (string) — The originating wallet address of the transaction. - `from_chain` (string) — The originating chain of the transaction, in cases of cross-chain activities. - `from_label` (string) — A shortened, more readable version of the originating wallet address. - `index` (integer) — A numeric index or identifier for the transaction. - `platform` (string) — The platform or service used for the transaction. - `price` (number) — The price of the token at the time of the transaction. - `timestamp` (integer) — The timestamp when the transaction occurred. - `to` (string) — The destination wallet address of the transaction. - `to_chain` (string) — The destination chain of the transaction, in cases of cross-chain activities. - `to_label` (string) — A shortened, more readable version of the destination wallet address. - `token_address` (string) — The address of the token involved in the transaction. - `token_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token_name` (string) — The name of the token involved in the transaction. - `token_symbol` (string) — The symbol of the token involved in the transaction. - `tx_hash` (string) — The unique hash identifier of the transaction. - `tx_type` (string) — The type of transaction. - `type` (string) — Specifies the nature of the transaction, like 'withdraw', 'deposit', etc. - `wallet` (string) — The wallet address involved in the transaction. - `wallet_label` (string) — A shortened, more readable version of the wallet address. ### ChainsResponse - `data` (array) — Array of chain identifiers as used in `chains=` query parameters. - `status` (ResponseStatus) ### CommandFilter - `chains` (array) — The chains to filter. - `min_usd_value` (number) — The minimum USD value to filter. - `tokens` (array) — The tokens to filter. - `tx_types` (array) — The types of transactions to filter. ### ContractCreation - `amount_usd` (number) — The equivalent amount in USD of the wrapped tokens. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `contract_address` (string) — The address of the smart contract involved in the interaction. - `from` (string) — The originating wallet address for the transaction. - `from_label` (string) — A human-readable label or name associated with the originating wallet. - `index` (integer) — A numerical index or identifier for the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### ContractInteraction - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `contract_address` (string) — The address of the smart contract involved in the interaction. - `contract_label` (string) — A human-readable label or name associated with the smart contract. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address for the transaction. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### CreateUserListRequest - `description` (string) - `followed_list_id` (integer) - `is_public` (boolean) - `name` (string) - `wallets` (array) ### CreateUserListResponse - `data` (WalletsList) - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### DeleteTrackedWallets - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### DeleteUserListResponse - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### DumpRisk - `amount_usd` (number) — USD value of the position at the current token price. - `percent` (number) — Estimated price drop in percent (0-100). ### ErrorResponse - `data` (object) — A flexible object intended to hold the actual data payload of the response. The structure of this object can vary depending on the specific endpoint and the nature of the response. - `message` (string) — A descriptive message providing additional details about the response. In case of an error, this message typically contains information useful for understanding the error's cause or nature. - `status` (ResponseStatus) — A reference to the response status object. This status is a key indicator of whether the request was processed successfully or resulted in an error. ### Feed - `data` (object) — Contains the main data of the response, including a list of transaction items and pagination details. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### FeedSubscribeCommand - `filter` (CommandFilter) - `list_id` (string) - `type` (string) ### FeedUnsubscribeCommand - `type` (string) ### Flashloan - `address` (string) — The address of the token involved in the transaction. - `amount` (number) — The amount of tokens involved in the transaction. - `amount_usd` (number) — The equivalent amount in USD of the tokens involved in the transaction. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `dex` (string) — The decentralized exchange (DEX) where the flashloan transaction took place. - `from` (string) — The originating wallet address for the transaction. - `health_factor` (number) — The health factor of the wallet after the flashloan transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `name` (string) — The name of the token involved in the transaction. - `platform` (string) — The platform where the flashloan transaction took place. - `price_usd` (number) — The price of the token in USD. - `symbol` (string) — The symbol of the token involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `token_icon_link` (string) — A link to the icon of the token involved in the transaction. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### GetAllWalletsListsResponse - `data` (object) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### GetTrackedWallets - `data` (object) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### GetUserListsResponse - `data` (array) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### GetWalletByAddress - `data` (TrackedWallet) - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### LP - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `dex` (string) — The name of the decentralized exchange where the LP transaction occurred. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `lower_bound` (number) — Indicates the lower bound of the price range for the LP position, relevant in certain types of liquidity pools. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `token0_address` (string) — The address of the first token involved in the LP transaction. - `token0_amount` (number) — The amount of the first token involved in the transaction. - `token0_amount_usd` (number) — The USD value of the first token amount at the time of the transaction. - `token0_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token0_name` (string) — The name of the first token involved in the transaction. - `token0_price_usd` (number) — The price of the first token in USD. - `token0_symbol` (string) — The symbol of the first token involved in the transaction. - `token1_address` (string) — The address of the second token involved in the LP transaction. - `token1_amount` (number) — The amount of the second token involved in the transaction. - `token1_amount_usd` (number) — The USD value of the second token amount at the time of the transaction. - `token1_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token1_name` (string) — The name of the second token involved in the transaction. - `token1_price_usd` (number) — The price of the second token in USD. - `token1_symbol` (string) — The symbol of the second token involved in the transaction. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `type` (string) — Specifies the nature of the LP transaction, such as 'add' or 'remove'. - `upper_bound` (number) — Indicates the upper bound of the price range for the LP position, relevant in certain types of liquidity pools. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### Lending - `action` (string) — Describes the action taken in the transaction, such as 'Repaid' in a lending scenario. - `address` (string) — The smart contract address involved in the transaction. - `amount` (number) — The amount of the asset involved in the transaction. - `amount_usd` (number) — The equivalent value of the transaction amount in USD. - `block` (integer) — The block number in the blockchain where this transaction is recorded. - `chain` (string) — Indicates the blockchain network on which the transaction occurred. - `dex` (string) — The decentralized exchange or platform where the transaction occurred, such as AaveV2. - `from` (string) — The originating wallet address for the transaction. - `from_label` (string) — A readable, abbreviated form of the 'from' wallet address. - `health_factor` (number) — A metric specific to lending platforms, indicating the health of the loan or position. - `index` (integer) — A sequential index or identifier for the transaction within a particular dataset or list. - `name` (string) — The name of the asset involved in the transaction. - `platform` (string) — The DeFi platform associated with the transaction, like AaveV3. - `price_usd` (number) — The price of the asset in USD at the time of the transaction. - `symbol` (string) — The symbol of the asset involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `token_icon_link` (string) — A URL link to the icon image of the token involved in the transaction. - `tx_hash` (string) — The unique identifier of the transaction, represented as a hash. - `tx_type` (string) — Specifies the type of DeFi transaction, such as lending, borrowing, etc. - `wallet` (string) — The wallet address associated with the transaction. - `wallet_label` (string) — A more readable, shortened version of the wallet address. ### NewTokenFlowItem - `address` (string) — Token contract address. - `avg_buy_usd` (integer) — Average buy price in USD. - `avg_sell_usd` (integer) — Average sell price in USD. - `buy_amount` (integer) — Total buy token amount. - `buy_usd` (integer) — Total buy amount in USD. - `buy_usd_width` (integer) — Relative width for buy visualization. - `chain` (string) — Blockchain chain. - `chart_link` (string) — Link to chart for this token. - `name` (string) — Token name. - `net_flow_amount` (integer) — Net flow token amount. - `net_flow_usd` (integer) — Net flow in USD (buy - sell). - `net_flow_usd_width` (integer) — Relative width for net flow visualization. - `platform` (string) — Token launch platform code (Solana tokens only). - `platform_uri` (string) — URL to the token on its launch platform (Solana tokens only). - `sell_amount` (integer) — Total sell token amount. - `sell_usd` (integer) — Total sell amount in USD. - `sell_usd_width` (integer) — Relative width for sell visualization. - `symbol` (string) — Token symbol. - `timestamp` (integer) — Token creation timestamp (Unix epoch). - `trades_num` (integer) — Number of trades. - `wallets_num` (integer) — Number of distinct wallets. ### NftLending - `action` (string) — Describes the action taken in the NFT lending transaction, such as 'buy', 'lend', etc. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network on which the transaction was conducted. - `currency_address` (string) — The blockchain address of the currency used in the transaction. - `currency_symbol` (string) — The symbol of the currency used in the transaction. - `from` (string) — The originating wallet address of the transaction. - `from_label` (string) — A readable version of the 'from' wallet address. - `image` (string) — A full image URL of the NFT. - `index` (integer) — A numerical index or identifier for the transaction. - `interest` (number) — The interest rate applied in the NFT lending transaction. - `nft_address` (string) — The blockchain address of the NFT involved in the transaction. - `nft_name` (string) — The name of the NFT. - `nft_symbol` (string) — The symbol of the NFT. - `nft_token_id` (string) — The unique identifier for the specific NFT within its collection. - `platform` (string) — The platform or service through which the NFT lending transaction was conducted. - `price` (number) — The price at which the NFT was lent or transacted. - `price_usd` (number) — The equivalent USD value of the transaction price. - `refinance` (boolean) — Indicates whether the transaction involved refinancing of the NFT. - `terms` (number) — Specifies the terms of the NFT lending agreement. - `thumbnail` (string) — A thumbnail image URL of the NFT involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address of the transaction. - `to_label` (string) — A readable version of the 'to' wallet address. - `tx_hash` (string) — The unique hash identifier of the NFT lending transaction. - `tx_type` (string) — Specifies the type of transaction, in this case, NFT lending. - `wallet` (string) — The wallet address involved in the NFT lending transaction. - `wallet_label` (string) — A more readable label or identifier for the wallet address. ### NftLiquidation - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `contract_address` (string) — The address of the NFT contract involved in the interaction. - `currency_address` (string) — The address of the currency involved in the transaction. - `currency_symbol` (string) — The symbol of the currency involved in the transaction. - `dex` (string) — The decentralized exchange where the wrap transaction occurred. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `nft_address` (string) — The address of the NFT contract involved in the interaction. - `nft_name` (string) — The name of the NFT in the transaction. - `nft_symbol` (string) — The symbol of the NFT in the transaction. - `platform` (string) — The platform where the flashloan transaction took place. - `price` (number) — The price of the NFT in the transaction. - `price_usd` (number) — The price of the NFT in USD. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address for the transaction. - `token_id` (string) — The unique identifier of the NFT in the transaction. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### NftMint - `amount` (number) — The number of items of the NFT minted in the transaction. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network on which the minting transaction was conducted. - `contract_address` (string) — The blockchain address of the contract under which the NFT is minted. - `contract_type` (string) — The type of contract used for the NFT, such as ERC721. - `currency_symbol` (string) — The symbol of the currency used in the transaction (e.g., ETH, MATIC). - `fee` (number) — The transaction fee incurred for minting the NFT. - `from` (string) — The originating wallet address of the transaction. - `from_label` (string) — A readable version of the 'from' wallet address. - `image` (string) — A full image URL of the NFT. - `index` (integer) — A numerical index or identifier for the transaction. - `nft_name` (string) — The name of the NFT minted. - `nft_symbol` (string) — The symbol associated with the NFT. - `nft_token_id` (string) — The unique token ID of the minted NFT. - `thumbnail` (string) — A thumbnail image URL of the NFT involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address of the transaction. - `to_label` (string) — A readable version of the 'to' wallet address. - `tx_hash` (string) — The unique hash identifier of the NFT minting transaction. - `tx_type` (string) — Specifies the type of transaction, in this case, NFT minting. - `type` (string) — Indicates the contract standard of the NFT, such as ERC721. - `value` (number) — The value of the transaction. For minting, this is often zero since the NFT is being created. - `value_usd` (number) — The equivalent USD value of the transaction. - `wallet` (string) — The wallet address involved in the NFT minting transaction. - `wallet_label` (string) — A more readable label or identifier for the wallet address. ### NftPnLItem - `chain` (string) - `nft_name` (string) - `nft_symbol` (string) - `num_swaps` (integer) - `profit_loss` (number) - `roi_percentage` (number) - `token_address` (string) - `total_buy_amount` (number) - `total_buy_avg` (number) - `total_buy_usd` (number) - `total_sell_amount` (number) - `total_sell_avg` (number) - `total_sell_usd` (number) ### NftSweep - `action` (string) — Describes the action taken in the NFT trade, such as 'buy' or 'sell'. - `bid_accepted` (boolean) — Specifies if the transaction involved a bid being accepted. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `buyer` (string) — The wallet address of the buyer in the trade. - `chain` (string) — The blockchain network where the trading transaction occurred. - `contract` (string) — The blockchain contract address associated with the NFT. - `currency_symbol` (string) — The symbol of the currency used in the trade, such as WETH or ETH. - `first_interaction` (boolean) — Indicates whether this was the first interaction between the buyer and seller. - `from` (string) — The originating wallet address of the transaction. - `image` (string) — A full image URL of the NFT. - `index` (integer) — A numerical index or identifier for the transaction. - `marketplace` (string) — The marketplace where the NFT trade occurred, such as OpenSea. - `nft_address` (string) — The blockchain address of the NFT involved in the trade. - `nft_name` (string) — The name of the NFT traded. - `nft_symbol` (string) — The symbol associated with the NFT. - `nft_token_id` (string) — The unique token ID of the NFT involved in the trade. - `price` (number) — The price at which the NFT was traded. - `price_usd` (number) — The equivalent USD value of the NFT trade. - `profit` (number) — The profit earned from the trade. This may be zero in some transactions. - `seller` (string) — The wallet address of the seller in the trade. - `thumbnail` (string) — A thumbnail image URL of the NFT involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address of the transaction. - `token` (string) — The token type used in the transaction. - `tx_hash` (string) — The unique hash identifier of the NFT trading transaction. - `tx_type` (string) — Specifies the type of transaction, in this case, NFT trading. - `wallet` (string) — The wallet address involved in the NFT trading transaction. - `wallet_label` (string) — A readable label for the wallet address. ### NftTrade - `action` (string) — Describes the action taken in the NFT trade, such as 'buy' or 'sell'. - `bid_accepted` (boolean) — Specifies if the transaction involved a bid being accepted. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `buyer` (string) — The wallet address of the buyer in the trade. - `chain` (string) — The blockchain network where the trading transaction occurred. - `contract` (string) — The blockchain contract address associated with the NFT. - `currency_symbol` (string) — The symbol of the currency used in the trade, such as WETH or ETH. - `first_interaction` (boolean) — Indicates whether this was the first interaction between the buyer and seller. - `from` (string) — The originating wallet address of the transaction. - `image` (string) — A full image URL of the NFT. - `index` (integer) — A numerical index or identifier for the transaction. - `marketplace` (string) — The marketplace where the NFT trade occurred, such as OpenSea. - `nft_address` (string) — The blockchain address of the NFT involved in the trade. - `nft_name` (string) — The name of the NFT traded. - `nft_symbol` (string) — The symbol associated with the NFT. - `nft_token_id` (string) — The unique token ID of the NFT involved in the trade. - `price` (number) — The price at which the NFT was traded. - `price_usd` (number) — The equivalent USD value of the NFT trade. - `profit` (number) — The profit earned from the trade. This may be zero in some transactions. - `seller` (string) — The wallet address of the seller in the trade. - `thumbnail` (string) — A thumbnail image URL of the NFT involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address of the transaction. - `token` (string) — The token type used in the transaction. - `tx_hash` (string) — The unique hash identifier of the NFT trading transaction. - `tx_type` (string) — Specifies the type of transaction, in this case, NFT trading. - `wallet` (string) — The wallet address involved in the NFT trading transaction. - `wallet_label` (string) — A readable label for the wallet address. ### NftTransfer - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network where the transfer transaction occurred. - `contract_address` (string) — The blockchain address of the contract under which the NFT is registered. - `contract_type` (string) — The type of contract used for the NFT, such as ERC721. - `fee` (number) — The transaction fee incurred for the transfer of the NFT. - `from` (string) — The originating wallet address of the transaction. - `from_label` (string) — A readable version of the 'from' wallet address. - `image` (string) — A full image URL of the NFT. - `index` (integer) — A numerical index or identifier for the transaction. - `nft_name` (string) — The name of the NFT being transferred. - `nft_symbol` (string) — The symbol associated with the NFT. - `nft_token_id` (string) — The unique token ID of the NFT involved in the transfer. - `thumbnail` (string) — A thumbnail image URL of the NFT involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address of the transaction. - `to_label` (string) — A readable version of the 'to' wallet address. - `tx_hash` (string) — The unique hash identifier of the NFT transfer transaction. - `tx_type` (string) — Specifies the type of transaction, in this case, NFT transfer. - `type` (string) — Indicates the contract standard of the NFT, such as ERC721. - `value` (number) — The value of the NFT at the time of the transfer. This might be represented in the native cryptocurrency of the blockchain. - `wallet` (string) — The wallet address involved in the NFT transfer transaction. - `wallet_label` (string) — A readable label for the wallet address. ### NftsPnL - `data` (object) — Contains the main data of the response, including a list of Nft PnL items and pagination details. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### Option - `action` (string) — The action taken in the option event. - `amount` (number) — The amount of tokens involved in the transaction. - `asset` (string) — The asset involved in the option event. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `dex` (string) — The decentralized exchange (DEX) where the option event took place. - `direction` (string) — The direction of the option event. - `expiry` (string) — The expiry date of the option. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `option_price_usd` (number) — The price of the option in USD. - `position_status` (string) — The status of the option position. - `spot_price_usd` (number) — The spot price of the asset in USD. - `status` (string) — The status of the option event. - `strike_price_usd` (number) — The strike price of the option in USD. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address for the transaction. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `type` (string) — The type of option event. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### Paging - `has_next_page` (boolean) - `page` (integer) - `total_rows_in_page` (integer) ### Perp - `action` (string) — The action taken in the Perpetual event. - `amount_usd` (number) — The equivalent amount in USD of the tokens involved in the transaction. - `average_price` (number) — The average price of the tokens involved in the transaction. - `base_token_address` (string) — The address of the base token involved in the transaction. - `base_token_amount` (number) — The amount of base tokens involved in the transaction. - `base_token_symbol` (string) — The symbol of the base token involved in the transaction. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `dex` (string) — The decentralized exchange where the Perpetual transaction occurred. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `is_nft_perp` (boolean) — Indicates whether the Perpetual transaction involves an NFT. - `leverage` (number) — The leverage used in the Perpetual transaction. - `liquidation` (boolean) — Indicates whether the transaction was a liquidation. - `liquidation_price` (number) — The price at which the liquidation occurred. - `perp_details` (string) — Additional details about the Perpetual transaction. - `position_size` (number) — The size of the position in the Perpetual transaction. - `position_size_usd` (number) — The equivalent amount in USD of the position size. - `realized_pnl` (number) — The realized profit and loss of the Perpetual transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address for the transaction. - `token0_address` (string) — The address of the first token in the LP pair. - `token0_amount` (number) — The amount of the first token in the LP pair. - `token0_amount_usd` (number) — The equivalent amount in USD of the first token in the LP pair. - `token0_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token0_name` (string) — The name of the first token in the LP pair. - `token0_price_usd` (number) — The price of the first token in the LP pair in USD. - `token0_symbol` (string) — The symbol of the first token in the LP pair. - `token1_address` (string) — The address of the second token in the LP pair. - `token1_amount` (number) — The amount of the second token in the LP pair. - `token1_amount_usd` (number) — The equivalent amount in USD of the second token in the LP pair. - `token1_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token1_name` (string) — The name of the second token in the LP pair. - `token1_price_usd` (number) — The price of the second token in the LP pair in USD. - `token1_symbol` (string) — The symbol of the second token in the LP pair. - `trade_direction` (string) — The direction of the trade in the Perpetual transaction. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `unrealized_pnl` (number) — The unrealized profit and loss of the Perpetual transaction. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### PnLPaging - `has_next_page` (boolean) - `next_object` (string) - `total_rows_in_page` (integer) ### PortfolioAsset - `balance` (number) — The token balance. - `chain` (string) — The chain of the token. - `platform` (string) — The token launch platform code. - `platform_ui` (string) — The human-readable token launch platform name. - `supply` (number) — The token supply. - `supply_owned` (number) — The token supply owned. - `token_address` (string) — The token address. - `token_name` (string) — The token name. - `token_price_usd` (number) — The token price in USD. - `token_symbol` (string) — The token symbol. - `total_usd_value` (number) — The total USD value. ### RelatedWallets - `data` (object) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### ResponseStatus string ### Reward - `address` (string) — The address of the token involved in the transaction. - `amount` (number) — The amount of tokens involved in the transaction. - `amount_usd` (number) — The equivalent amount in USD of the tokens involved in the transaction. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `name` (string) — The name of the token involved in the transaction. - `price_usd` (number) — The price of the token in USD. - `symbol` (string) — The symbol of the token involved in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### Staking - `action` (string) — The action taken in the staking transaction. - `amount` (number) — The amount of tokens staked in the transaction. - `amount_usd` (number) — The equivalent amount in USD of the staked tokens. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `contract_address` (string) — The address of the smart contract involved in the interaction. - `from` (string) — The originating wallet address for the transaction. - `from_label` (string) — A human-readable label or name associated with the originating wallet. - `index` (integer) — A numerical index or identifier for the transaction. - `name` (string) — The name of the token staked in the transaction. - `symbol` (string) — The symbol of the token staked in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address for the transaction. - `to_label` (string) — A human-readable label or name associated with the destination wallet. - `token_price_usd` (number) — The price of the token in USD. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### SudoPool - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `dex` (string) — The decentralized exchange where the wrap transaction occurred. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `nft_address` (string) — The address of the NFT contract involved in the interaction. - `nft_amount` (integer) — The amount of NFTs involved in the transaction. - `nft_price` (number) — The price of the NFT in the transaction. - `nft_symbol` (string) — The symbol of the NFT in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address for the transaction. - `token0_address` (string) — The address of the first token in the LP pair. - `token0_amount` (number) — The amount of the first token in the LP pair. - `token0_amount_usd` (number) — The equivalent amount in USD of the first token in the LP pair. - `token0_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token0_name` (string) — The name of the first token in the LP pair. - `token0_price_usd` (number) — The price of the first token in the LP pair in USD. - `token0_symbol` (string) — The symbol of the first token in the LP pair. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name. ### Swap - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network where the swap transaction occurred. - `dex` (string) — The decentralized exchange where the swap transaction took place. - `first_interaction` (boolean) — Indicates whether this transaction was the first interaction between the involved wallet addresses. - `from` (string) — The originating wallet address of the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `is_sell` (boolean) — Indicates whether the swap transaction was a sell order. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address of the transaction (often the same as the 'from' address in swap transactions). - `token0_address` (string) — The address of the first token involved in the swap. - `token0_amount` (number) — The amount of the first token involved in the swap. - `token0_amount_usd` (number) — The USD value of the first token amount at the time of the swap. - `token0_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token0_name` (string) — The name of the first token involved in the swap. - `token0_price_usd` (number) — The price of the first token in USD. - `token0_symbol` (string) — The symbol of the first token involved in the swap. - `token1_address` (string) — The address of the second token involved in the swap. - `token1_amount` (number) — The amount of the second token involved in the swap. - `token1_amount_usd` (number) — The USD value of the second token amount at the time of the swap. - `token1_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token1_name` (string) — The name of the second token involved in the swap. - `token1_price_usd` (number) — The price of the second token in USD. - `token1_symbol` (string) — The symbol of the second token involved in the swap. - `token_market_cap` (object) — Contains the market capitalization and liquidity details of the tokens involved in the swap transaction. - `tx_hash` (string) — The unique hash identifier of the swap transaction. - `tx_type` (string) — Specifies the type of transaction, in this case, a token swap. - `wallet` (string) — The wallet address that initiated the swap transaction. - `wallet_label` (string) — A readable label for the wallet address. ### TagModel - `description` (string) — A description of what the tag represents. - `key` (TagTypes) — A unique identifier for the tag. - `tag` (string) — The tag label or name. ### TagTypes string ### Tags - `data` (object) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### ToggleFollowListResponse - `data` (object) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### TokenBalanceResponse - `balance` (number) — The token balance. - `chain` (string) — The chain of the token. - `decimals` (integer) — The number of decimals for the token. - `token_address` (string) — The token address. - `token_name` (string) — The token name. - `token_price_usd` (number) — The token price in USD. - `token_symbol` (string) — The token symbol. - `total_usd_value` (number) — The total USD value. ### TokenChecklistResponse - `data` (object) — Contains token checklist information. - `message` (string) — A message describing the result of the API request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### TokenFlowV2Item - `address` (string) — Token contract address. - `avg_buy_usd` (integer) — Average buy price in USD. - `avg_sell_usd` (integer) — Average sell price in USD. - `buy_amount` (integer) — Total buy token amount. - `buy_usd` (integer) — Total buy amount in USD. - `buy_usd_width` (integer) — Relative width for buy visualization. - `chain` (string) — Blockchain chain. - `chart_link` (string) — Link to chart for this token. - `name` (string) — Token name. - `net_flow_amount` (integer) — Net flow token amount. - `net_flow_usd` (integer) — Net flow in USD (buy - sell). - `net_flow_usd_width` (integer) — Relative width for net flow visualization. - `platform` (string) — Token launch platform code (Solana tokens only). - `platform_uri` (string) — URL to the token on its launch platform (Solana tokens only). - `sell_amount` (integer) — Total sell token amount. - `sell_usd` (integer) — Total sell amount in USD. - `sell_usd_width` (integer) — Relative width for sell visualization. - `symbol` (string) — Token symbol. - `trades_num` (integer) — Number of trades. - `wallets_num` (integer) — Number of distinct wallets. ### TokenMetadataResponse - `data` (object) — Contains token metadata information. - `message` (string) — A message describing the result of the API request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### TokenPriceResponse - `data` (object) — Contains token price. - `message` (string) — A message describing the result of the API request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### TokenStatsLiquidityResponse - `data` (object) — Aggregated liquidity information for the token. - `message` (string) - `status` (ResponseStatus) — Standard response status indicating success or failure of the API request. ### TokenStatsResponse - `data` (object) — Contains comprehensive token statistics information. - `message` (string) — A message describing the result of the API request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### TokensPNL - `data` (object) — Contains the main data of the response, including a list of tokens PNL items and pagination details. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### TokensPNLItem - `average_buy_price` (number) - `average_sell_price` (number) - `avg_buy_market_cap_usd` (number) — Estimated market cap at the average buy price, calculated as avg_buy_price * (current_market_cap / current_price). Only populated when CieloPricer data is available. - `avg_sell_market_cap_usd` (number) — Estimated market cap at the average sell price, calculated as avg_sell_price * (current_market_cap / current_price). Only populated when CieloPricer data is available. - `chain` (string) - `held_by` (string) — Wallet address that holds this token. Only present when using multi_bundle_id parameter. - `held_by_labels` (object) — Map of held_by wallet address to its bundle label. Only wallets that have a non-empty label appear; consumers fall back to the address for the rest. Only present when using multi_bundle_id parameter. - `holding_amount` (number) — The current holding amount of the token - `holding_amount_usd` (number) — The current holding amount in USD - `holding_time_seconds` (integer) — The token holding time in seconds. - `is_honeypot` (boolean) - `num_buys` (integer) — Buy count. num_buys + num_sells == num_swaps. - `num_sells` (integer) — Sell count. num_buys + num_sells == num_swaps. - `num_swaps` (integer) - `platform` (string) — Platform or protocol the token is associated with (e.g., "pump-fun", "boop-fun", "solana") - `platform_ui` (string) — Human-readable platform name (e.g., "Pump.fun", "Boop", "Solana") - `roi_percentage` (number) - `token_address` (string) - `token_age` (integer) — Time in seconds since the token's launch when the wallet first entered the token. - `token_name` (string) - `token_price` (number) - `token_symbol` (string) - `total_buy_amount` (number) - `total_buy_usd` (number) - `total_pnl_usd` (number) - `total_sell_amount` (number) - `total_sell_usd` (number) - `unrealized_pnl_usd` (number) - `unrealized_roi_percentage` (number) ### TotalStats - `data` (object) — Contains the main data of the response, including aggregated PnL stats for the specified wallet. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### TrackedWallet - `id` (number) — The unique identifier for the tracked wallet. - `label` (string) — The label for the related wallet. - `list` (WalletsList) - `list_id` (number) — The list id for the tracked wallet. - `type` (WalletTypes) - `wallet` (string) — The wallet address for which the related wallets are provided. ### TrackedWalletsPaging - `has_next_page` (boolean) — Indicates whether there is a next page of results. - `next_object` (number) — The index of the next object in the result set. - `total_rows_in_page` (number) — The total number of rows in the current page. ### Transfer - `amount_usd` (number) — The USD value of the amount transferred in the transaction. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network where the transfer transaction occurred. - `contract_address` (string) — The blockchain address of the contract under which the token is registered. - `from` (string) — The originating wallet address of the transaction. - `from_label` (string) — A readable version of the 'from' wallet address. - `index` (integer) — A numerical index or identifier for the transaction. - `mempool` (boolean) — For Bitcoin transactions, this field indicates whether the transaction is in the mempool. - `name` (string) — The name of the token being transferred. - `symbol` (string) — The symbol of the token being transferred. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address of the transaction. - `to_label` (string) — A readable version of the 'to' wallet address. - `token_icon_link` (string) — A URL link to the token's icon image. - `token_market_cap` (object) — Contains the market capitalization and liquidity details of the tokens involved in the swap transaction. - `token_price_usd` (number) — The price of the token in USD at the time of the transaction. - `tx_hash` (string) — The unique hash identifier of the transfer transaction. - `tx_type` (string) — Specifies the type of transaction, in this case, a token transfer. - `type` (string) — Indicates the contract standard of the token, such as ERC20. - `wallet` (string) — The wallet address involved in the transfer transaction. - `wallet_label` (string) — A readable label for the wallet address. ### TrendingTokenItem - `avg_buy` (number) — Average buy amount. - `bonding_curve_percentage` (number) — Bonding curve percentage. - `buy_count` (integer) — Number of buy transactions. - `buy_volume_usd` (number) — Buy volume in USD. - `chain` (string) — The blockchain network. - `coverage_complete` (boolean) — False for partial observed history or rolling warmup; null when unavailable. Lifetime statistics and trending window statistics have separate coverage. - `dev_percentage` (number) — Developer wallet percentage. - `dex_paid` (boolean) — Whether DEX has been paid. - `fresh_wallets_percentage` (number) — Percentage of fresh wallets. - `holders` (integer) — Number of token holders. - `is_deleted` (integer) — Deletion flag. - `liquidity` (number) — Total liquidity in USD. - `market_cap` (number) — Market cap in USD. - `mindshare` (number) — Mindshare score. - `mindshare_breakdown` (array) - `net_flow` (number) — Net flow value. - `platform` (string) — The platform code. - `platform_ui` (string) — Human-readable platform name. - `platform_uri` (string) — Platform URI. - `popular_wallets` (integer) — Number of popular wallets. - `price_change_percentage` (number) — Price change percentage. - `pro_traders` (integer) — Unsigned 64-bit count (0 to 18446744073709551615). Observed distinct eligible makers with confirmed token-specific terminal use; null when unavailable. - `pro_traders_percentage` (number) — 100 × pro_traders divided by traders (0–100); zero for an available empty population, null when unavailable. - `sell_count` (integer) — Number of sell transactions. - `sell_volume_usd` (number) — Sell volume in USD. - `sniper_percentage` (number) — Percentage of sniper wallets. - `telegram` (string) — Telegram link. - `token_address` (string) — The token contract address. - `token_age` (integer) — Token age in seconds. - `token_name` (string) — The token name. - `token_symbol` (string) — The token symbol. - `top_20_percentage` (number) — Top 20 holders percentage. - `traders` (integer) — Unsigned 64-bit count (0 to 18446744073709551615). Distinct eligible makers from the same population and time window as pro_traders. - `unique_wallets` (integer) — Number of unique wallets that traded this token in the given interval. - `volume_24h` (number) — 24-hour trading volume in USD. - `website` (string) — Website URL. - `whales` (integer) — Number of whale wallets. ### TrendingTokensResponse - `data` (object) - `message` (string) - `status` (string) ### UpdateTrackedWallet - `data` (TrackedWallet) - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### UpdateUserListRequest - `description` (string) - `followed_list_id` (integer) - `is_public` (boolean) - `name` (string) - `wallets` (array) ### UpdateUserListResponse - `data` (WalletsList) - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### VolumeStats - `buy_volume_usd` (number) — Total buy volume in USD for the time period. - `buys` (integer) — Total number of buy transactions in the time period. - `sell_volume_usd` (number) — Total sell volume in USD for the time period. - `sells` (integer) — Total number of sell transactions in the time period. - `unique_buyers` (integer) — Number of unique addresses that bought the token in the time period. - `unique_sellers` (integer) — Number of unique addresses that sold the token in the time period. - `volume_usd` (number) — Total trading volume in USD for the time period. ### WalletPortfolioResponse - `data` (object) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### WalletSubscribeCommand - `filter` (CommandFilter) - `type` (string) - `wallet` (string) ### WalletTokenPosition - `avg_buy_market_cap_usd` (number) - `avg_buy_price_native` (number) - `avg_buy_price_usd` (number) - `avg_sell_market_cap_usd` (number) - `avg_sell_price_native` (number) - `avg_sell_price_usd` (number) - `bought_amount` (number) - `bought_native` (number) - `bought_usd` (number) - `chain` (string) - `collateral` (string) — The token the position was traded against. - `cost_basis_carried` (boolean) — True when the cost basis was carried over from another wallet in the same request that bought the tokens and transferred them here. - `current_price_native` (number) - `current_price_usd` (number) - `has_cost_basis` (boolean) — False for holdings the wallet never traded on Cielo (transferred in, airdropped, bought elsewhere); their cost-basis and PnL fields are zero. - `holding_amount` (number) - `holding_native` (number) - `holding_raw` (string) — The holding in the token's smallest unit. - `holding_usd` (number) - `last_trade_timestamp` (integer) — Unix timestamp of the wallet's last trade in this token. - `market_cap` (number) - `migrated_at` (integer) — Unix timestamp of the token's migration off its launchpad, if any. - `platform` (string) — The token launch platform code. - `platform_ui` (string) — The human-readable token launch platform name. - `realized_profit_native` (number) - `realized_profit_roi` (number) - `realized_profit_roi_native` (number) - `realized_profit_usd` (number) - `sold_amount` (number) - `sold_fees_native` (number) - `sold_fees_usd` (number) - `sold_native` (number) - `sold_usd` (number) - `token_address` (string) - `token_name` (string) - `token_symbol` (string) - `total_profit_native` (number) - `total_profit_roi` (number) - `total_profit_roi_native` (number) - `total_profit_usd` (number) - `unrealized_profit_native` (number) - `unrealized_profit_roi` (number) - `unrealized_profit_roi_native` (number) - `unrealized_profit_usd` (number) - `wallet` (string) ### WalletTokenPositionsResponse - `data` (object) - `status` (ResponseStatus) ### WalletTypes object ### WalletUnsubscribeCommand - `type` (string) - `wallet` (string) ### WalletsByTag - `data` (object) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### WalletsList - `bot_id` (integer) - `created_at` (integer) - `description` (string) - `followed` (boolean) - `followed_count` (integer) - `id` (integer) - `image_url` (string) - `is_creator` (boolean) - `is_public` (boolean) - `name` (string) - `share_url` (string) - `wallets_count` (integer) ### WalletsListPaging - `has_next_page` (boolean) - `next_object` (string) - `total_rows_in_page` (integer) ### WalletsTags - `data` (array) — Contains the main data of the response. - `message` (string) — A descriptive message accompanying the response, often used to provide additional information or context about the results or the status of the request. - `status` (ResponseStatus) — A reference to the standard response status object, which indicates the success or failure of the API request. ### WebsocketCommand object ### WebsocketErrorEvent - `data` (string) — The error message. - `type` (string) ### WebsocketEvent object ### WebsocketTxEvent - `data` (object) — The event data. - `type` (string) — The type of event. ### Wrap - `action` (string) - `amount` (number) — The amount of tokens wrapped in the transaction. - `amount_usd` (number) — The equivalent amount in USD of the wrapped tokens. - `block` (integer) — The block number on the blockchain where this transaction is recorded. - `chain` (string) — The blockchain network (e.g., Ethereum, Optimism) where this transaction takes place. - `contract_address` (string) — The address of the smart contract involved in the interaction. - `dex` (string) — The decentralized exchange where the wrap transaction occurred. - `from` (string) — The originating wallet address for the transaction. - `index` (integer) — A numerical index or identifier for the transaction. - `name` (string) — The name of the token wrapped in the transaction. - `symbol` (string) — The symbol of the token wrapped in the transaction. - `timestamp` (integer) — The timestamp marking when the transaction was executed. - `to` (string) — The destination wallet address for the transaction. - `token_icon_link` (string) — A link to the icon of the token involved in the transaction. - `token_price_usd` (number) — The price of the token in USD at the time of the transaction. - `token_type` (string) — The type of token wrapped in the transaction. - `tx_hash` (string) — The unique transaction hash identifying this specific LP transaction. - `tx_type` (string) — Indicates the type of transaction, in this case, liquidity pool (LP) related. - `wallet` (string) — The wallet address participating in the LP transaction. - `wallet_label` (string) — A human-readable label or name associated with the wallet, such as a ENS name.