V3 endpoints
These endpoints require a Client API Key or Client Session Token (CST) as a bearer token.
Get Client Details
GET
https://api.portalhq.io/api/v3/clients/me
This endpoint retrieves the details of the current client, including information about associated wallets.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer |
Content-Type* | String | application/json |
Get Assets by Chain
GET
https://api.portalhq.io/api/v3/clients/me/chains/:chain/assets
This endpoint retrieves the asset balances (native and token balances) for a specified blockchain. It provides detailed information on the native balance and token balances held by a given address on the specified chain.
Supported Chains
You can use either the full chain identifier or the shortcut for popular chains.
Ethereum Mainnet (
eip155:1
orethereum
)Ethereum Sepolia (
eip155:11155111
orsepolia
)Solana Mainnet (
solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
orsolana
)Solana Devnet (
solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1
orsolana-devnet
)Base Mainnet (
eip155:8453
orbase
)Base Sepolia (
eip155:84532
orbase-sepolia
)Polygon Mainnet (
eip155:137
orpolygon
)Polygon Amoy (
eip155:80002
orpolygon-amoy
)Optimism Mainnet (
eip155:10
)Binance Smart Chain (
eip155:56
)Binance Smart Chain Testnet (
eip155:97
)Gnosis (
eip155:100
)Fantom (
eip155:250
)Moonbeam (
eip155:1284
)Arbitrum Mainnet (
eip155:42161
)Avalanche Mainnet (
eip155:43114
)Linea Mainnet (
eip155:59140
)Optimism Sepolia (
eip155:11155420
)Palm (
eip155:11297108109
)
When using CAIP-2 chain formats in the URL (e.g. eip155:11155111
), ensure the URL is URI encoded to accommodate the ":" character.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer |
Content-Type* | String | application/json |
Request Query Params
Name | Type | Description |
---|---|---|
chainId* | String | Must be in CAIP-2 format or chain identifier shortcut (e.g. |
includeNfts | Boolean - Defaults to | Optionally includes the NFTs of the client on the specified chain. |
Get NFT Assets by Chain
GET
https://api.portalhq.io/api/v3/clients/me/chains/:chain/assets/nfts
This endpoint retrieves the NFT assets for a specified blockchain.
Supported Chains
You can use either the full chain identifier or the shortcut for popular chains.
Ethereum Mainnet (
eip155:1
orethereum
)Ethereum Sepolia (
eip155:11155111
orsepolia
)Solana Mainnet (
solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
orsolana
)Solana Devnet (
solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1
orsolana-devnet
)Base Mainnet (
eip155:8453
orbase
)Base Sepolia (
eip155:84532
orbase-sepolia
)Polygon Mainnet (
eip155:137
orpolygon
)Polygon Amoy (
eip155:80002
orpolygon-amoy
)Optimism Mainnet (
eip155:10
)Binance Smart Chain (
eip155:56
)Binance Smart Chain Testnet (
eip155:97
)Gnosis (
eip155:100
)Fantom (
eip155:250
)Moonbeam (
eip155:1284
)Arbitrum Mainnet (
eip155:42161
)Avalanche Mainnet (
eip155:43114
)Linea Mainnet (
eip155:59140
)Optimism Sepolia (
eip155:11155420
)Palm (
eip155:11297108109
)
When using CAIP-2 chain formats in the URL (e.g. eip155:11155111
), ensure the URL is URI encoded to accommodate the ":" character.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer |
Content-Type* | String | application/json |
Request Query Params
Name | Type | Description |
---|---|---|
chainId* | String | Must be in CAIP-2 format or chain identifier shortcut (e.g. |
Get Transactions by Chain
GET
https://api.portalhq.io/api/v3/clients/me/transactions
Retrieves the client's transaction history for a specific chain.
Supported Chains
Ethereum Mainnet (
eip155:1
)Ethereum Goerli (
eip155:5
) // @deprecatedEthereum Sepolia (
eip155:11155111
)Base Mainnet (
eip155:8453
)Base Sepolia (
eip155:84532
)Polygon Mainnet (
eip155:137
)Polygon Mumbai (
eip155:80001
)Polygon Amoy (
eip155:80002
)
When using CAIP-2 chain formats in the URL (e.g. eip155:11155111
), ensure the URL is URI encoded to accommodate the ":" character.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer |
Content-Type* | String | application/json |
Request Query Params
Name | Type | Description |
---|---|---|
chainId* | String | Must be in CAIP-2 format (e.g. |
Build a Transaction to Send an Asset
POST
https://api.portalhq.io/api/v3/clients/me/chains/:chain/assets/send/build-transaction
Creates an unsigned transaction for transferring assets to another address on a specific chain. You can then use this unsigned transaction to sign and submit the transaction.
Supported Chains
You can use any of the following friendly chain names for the
chain
path param (or alternatively you can use the CAIP-2chainId
):ethereum
(eip155:1
)sepolia
(eip155:11155111
)base
(eip155:8453
)base-sepolia
(eip155:84531
)polygon
(eip155:137
)polygon-mumbai
(eip155:80001
)solana
(solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
)solana-devnet
(solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1
)
When using CAIP-2 chain formats in the URL (e.g. eip155:11155111
), ensure the URL is URI encoded to accommodate the ":" character.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer |
Content-Type* | String | application/json |
Request Path Params
Name | Type | Description |
---|---|---|
chain* | String | Must be one of the chains in "Supported Chains". |
Request Body
Name | Type | Description |
---|---|---|
to* | String | The recipient's address. |
token* | String | The token symbol (e.g., "USDC") or contract address or mint address (for Solana). |
amount* | String | The amount to transfer (as a string, in the token's primary denomination). For example, "0.01" is 1 cent of USDC. |
Example Request
Example Response
The response includes the unsigned transaction details and metadata. The structure of the response differs depending on whether the chain is Solana or an EIP-155 chain (e.g., Ethereum, Polygon, Base).
Notes
The
token
field can accept either a token symbol (e.g. "USDC" or "USDT") or a contract address (for EIP-155 tokens) or a mint address (for Solana tokens).The
amount
should be provided in the token's primary denomination (e.g. whole USDC, not micro-USDC).This endpoint creates an unsigned transaction. The client is responsible for signing the transaction before broadcasting it to the network.
The response structure differs between Solana and EIP-155 chains. Make sure to handle both response types in your implementation.
Evaluate a Transaction
POST
https://api.portalhq.io/api/v3/clients/me/evaluate-transaction
This endpoint evaluates a transaction by either simulating its execution or validating its authenticity (or both). The evaluation provides detailed insights into the transaction, including potential changes in asset balances, exposures, and a classification of the transaction's risk.
Supported Chains
Ethereum Mainnet (
eip155:1
)Ethereum Sepolia (
eip155:11155111
)Optimism Mainnet (
eip155:10
)Binance Smart Chain (
eip155:56
)Polygon Mainnet (
eip155:137
)Blast Mainnet (
eip155:238
)zkSync Mainnet (
eip155:324
)zkSync Sepolia (
eip155:300
)Base Mainnet (
eip155:8453
)Base Sepolia (
eip155:84532
)Immutable zkEVM (
eip155:13371
)Arbitrum Mainnet (
eip155:42161
)Avalanche Fuji (
eip155:43113
)Avalanche Mainnet (
eip155:43114
)Linea Mainnet (
eip155:59144
)Scroll Mainnet (
eip155:534352
)Zora Mainnet (
eip155:7777777
)Degen Mainnet (
eip155:666666666
)Solana Mainnet (
solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
)Solana Devnet (
solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1
)
When using CAIP-2 chain formats in the URL (e.g. eip155:11155111
), ensure the URL is URI encoded to accommodate the ":" character.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer |
Content-Type* | String | application/json |
Request Query Params
Name | Type | Description |
---|---|---|
chainId* | String | Must be in CAIP-2 format (e.g. |
Request Body
Name | Type | Description |
---|---|---|
to* | String | The recipient's address. |
gas | String (optional) | The gas limit provided for the transaction. |
gasPrice | String (optional) | The price per unit of gas the sender is willing to pay. |
maxFeePerGas | String (optional) | The maximum total fee per gas unit the sender is willing to pay. |
maxPriorityFeePerGas | String (optional) | The maximum priority fee per gas unit the sender is willing to pay. |
value | String (optional) | The amount of native token to send with the transaction. |
data | String (optional) | The input data to send with the transaction (used for contract calls). |
operationType |
Default: | The operation to perform with the transaction. |