> ## Documentation Index
> Fetch the complete documentation index at: https://coinstats.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Connect Portfolio Wallet
> Connect a wallet to your account and create a tracked portfolio
**40** credits per request
* A portfolioId you can use to query portfolio data (value, coins, chart, transactions, defi, snapshot)
* Automatic portfolio creation with visibility set to API
* Background transaction sync initiated
* address: Wallet address to connect
* connectionId: Blockchain network identifier (e.g., "ethereum"). Use GET /wallet/blockchains for supported networks.
* name: Custom display name for the portfolio
## OpenAPI
````yaml /api-reference/openapi.json post /v1/portfolio/wallet
openapi: 3.0.0
info:
title: CoinStats Public API
description: >-
CoinStats Public API — programmatic access to market data, news, NFTs,
wallets, exchange connections, and user portfolios. Authenticate every
request with the `X-API-KEY` header (or an OAuth Bearer token in the
`Authorization` header). Generate keys at https://openapi.coinstats.app.
version: '1.0'
contact: {}
servers:
- url: https://openapiv1.coinstats.app
security: []
tags:
- name: CoinStats
description: ''
- name: Market Data
description: >-
The Market Data section of the API provides endpoints to access a wide
range of market-related information, including cryptocurrency coins,
ticker data, and fiat currency rates. This category offers comprehensive
data to help users monitor and analyze the cryptocurrency market, track
prices, and gain insights into market trends
- name: News
description: >-
The News section of the API allows you to access news articles and updates
related to cryptocurrencies and the blockchain industry. It provides
valuable information from various sources to keep you informed about the
latest developments
- name: NFTs
description: >-
The NFT section of the API provides endpoints to interact with
Non-Fungible Tokens (NFTs), which are unique digital assets stored on a
blockchain. These endpoints allow you to retrieve information about NFTs,
including collections, assets, trending NFTs, and specific assets
associated with wallet addresses.
- name: Wallet Data
description: >-
The Wallet section of the API provides a comprehensive set of endpoints to
manage and interact with wallets. It enables users to retrieve wallet
balances, monitor syncing status, fetch transaction data, and synchronize
wallet information with the blockchain. By integrating these endpoints
into your application, you can offer robust wallet functionality to your
users.
- name: Exchange Connection
description: >-
The Exchange Connection section of the API provides a comprehensive set of
endpoints to manage and interact with exchanges. It enables users to
retrieve exchange balances, monitor syncing status, fetch transaction
data. By integrating these endpoints into your application, you can offer
robust exchange portfolio tracking functionality to your users.
- name: User Portfolio
description: >-
The Portfolio section of the API provides a comprehensive set of endpoints
to manage and interact with Share Portfolios. It enables users to retrieve
current Portfolio Coins and Transactions.
- name: Usage
description: The Usage section provides account-level API usage data.
- name: Status
description: The Status section provides API availability checks.
paths:
/v1/portfolio/wallet:
post:
tags:
- User Portfolio
summary: Connect a wallet to your account and create a tracked portfolio
operationId: connect-portfolio-wallet
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectWalletDto'
responses:
'200':
description: Connect Wallet Portfolio
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectPortfolioResponseDto'
'400':
description: Bad Request
content:
application/json:
example:
statusCode: 400
message: Bad Request
requestId: 11111111-2222-3333-4444-555555555555
path:
'401':
description: Unauthorized
content:
application/json:
example:
statusCode: 401
message: Unauthorized
requestId: 11111111-2222-3333-4444-555555555555
path:
'403':
description: Forbidden
content:
application/json:
example:
statusCode: 403
message: Forbidden
requestId: 11111111-2222-3333-4444-555555555555
path:
'404':
description: Not Found
content:
application/json:
example:
statusCode: 404
message: Not Found
requestId: 11111111-2222-3333-4444-555555555555
path:
'409':
description: Conflict (for some endpoints)
content:
application/json:
example:
statusCode: 409
message: Transactions not synced
requestId: 11111111-2222-3333-4444-555555555555
path:
'429':
description: Too Many Requests
content:
application/json:
example:
statusCode: 429
message: Rate limit exceeded
requestId: 11111111-2222-3333-4444-555555555555
path:
'503':
description: Service Unavailable
content:
application/json:
example:
statusCode: 503
message: Service Unavailable. Please Contact Support
security:
- X-API-KEY: []
components:
schemas:
ConnectWalletDto:
type: object
properties:
address:
type: string
example: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
description: Wallet address to connect.
connectionId:
type: string
example: ethereum
description: >-
Blockchain network identifier (e.g., "ethereum", "polygon"). Use GET
/wallet/blockchains to get the list of supported blockchains.
name:
type: string
example: My Ethereum Wallet
description: Optional display name for the portfolio.
required:
- address
- connectionId
ConnectPortfolioResponseDto:
type: object
properties:
portfolioId:
type: string
example: a1b2c3d4e5f6...
description: The unique identifier of the connected portfolio.
connectionId:
type: string
example: ethereum
description: The connectionId used to connect the portfolio.
status:
type: string
example: connected
enum:
- connected
- existing
description: >-
"connected" if a new portfolio was created, "existing" if the
portfolio already exists.
required:
- portfolioId
- connectionId
- status
securitySchemes:
X-API-KEY:
type: apiKey
in: header
name: X-API-KEY
description: >-
API key required to access the endpoints. Generate one from your
dashboard at https://openapi.coinstats.app and pass it in the
`X-API-KEY` request header. Never expose your key in client-side code.
````