Sections

Clients
Client Shares
Swaps
Yield.xyz Integration
Deprecated Endpoints

Clients

Get the client’s 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 `<Client API Key>`
Content-Type*	String	application/json

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request GET \
  --url https://api.portalhq.io/api/v3/clients/me \
  --header 'Authorization: Bearer [token]'

Example Response

200: OK Success
400: Bad Request
401: Unauthorized Request

{
  "createdAt": "2024-04-16T21:15:06.443Z",
  "custodian": {
    "id": "custodianId",
    "name": "Custodian Name"
  },
  "ejectedAt": null,
  "environment": {
    "id": "environmentId",
    "name": "Development"
  },
  "id": "clientId",
  "isAccountAbstracted": false,
  "metadata": {
    "namespaces": {
      "bip122": {
        "address": "",
        "curve": "SECP256K1",
        "bitcoin": {
          "p2wpkh": {
            "mainnet": "bc1qpl54na90wlmdxj5z4wtz7cpp6p32dc9th54w0m",
            "testnet": "tb1qpl54na90wlmdxj5z4wtz7cpp6p32dc9tajwa5g"
          }
        }
      },
      "solana": {
        "address": "BrGo1hFAL8MpudNQ6K4YWDaFB838uboUcCpm8C9uyC4R",
        "curve": "ED25519"
      },
      "stellar": {
        "address": "GCQTIL5333ASTDBXAJYDIAFRWXYGMR2KPGUNIDNSHOMBINTAMPZJFOKT",
        "curve": "ED25519"
      },
      "eip155": {
        "address": "0x0f3f5cea9784e254972d915695dbc9bc2a395faf",
        "curve": "SECP256K1"
      },
      "tron": {
        "address": "TBMq3UK8JNvauSc7sPUp7fkoSzTN4PZhP2",
        "curve": "SECP256K1"
      }
    }
  },
  "wallets": [
    {
      "createdAt": "2024-04-16T21:15:45.144Z",
      "curve": "SECP256K1",
      "id": "wallet1Id",
      "backupSharePairs": [
        {
          "backupMethod": "PASSWORD",
          "createdAt": "2024-04-16T21:16:48.723Z",
          "id": "backupSharePairId1",
          "status": "completed"
        },
        {
          "backupMethod": "GDRIVE",
          "createdAt": "2024-04-16T21:17:02.074Z",
          "id": "backupSharePairId2",
          "status": "incomplete"
        },
        {
          "backupMethod": "ICLOUD",
          "createdAt": "2024-04-16T21:18:06.996Z",
          "id": "backupSharePairId3",
          "status": "incomplete"
        }
      ],
      "signingSharePairs": [
        {
          "createdAt": "2024-04-16T21:15:45.151Z",
          "id": "signingSharePairId1",
          "status": "completed"
        }
      ],
      "publicKey": "stringifiedJSON"
    }
  ]
}

Get the client’s 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.

Monad Testnet (eip155:10143 or monad-testnet)
Solana Mainnet (solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp or solana)
Solana Devnet (solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1 or solana-devnet)
Bitcoin (bip122:000000000019d6689c085ae165831e93-p2wpkh or bitcoin-p2wpkh or bitcoin-segwit)
Bitcoin Testnet (bip122:000000000933ea01ad0ee984209779ba-p2wpkh or bitcoin-p2wpkh-testnet or bitcoin-segwit-testnet)
Celo (eip155:42220 or celo)
Celo Alfajores Testnet (eip155:44787 or celo-alfajores)
Tron (tron:mainnet)
Tron Nile (tron:nile)
Tron Shasta (tron:shasta)
Stellar (stellar:pubnet)
Stellar Testnet (stellar:testnet)
Ethereum Mainnet (eip155:1 or ethereum)
Ethereum Sepolia (eip155:11155111 or sepolia)
Base Mainnet (eip155:8453 or base)
Base Sepolia (eip155:84532 or base-sepolia)
Polygon Mainnet (eip155:137 or polygon)
Polygon Amoy (eip155:80002 or polygon-amoy)
Optimism Mainnet (eip155:10)
Binance Smart Chain (eip155:56)
Binance Smart Chain Testnet (eip155:97)
Fantom (eip155:250)
Moonbeam (eip155:1284)
Arbitrum Mainnet (eip155:42161)
Arbitrum Sepolia (eip155:421614)
Avalanche Mainnet (eip155:43114)
Linea Mainnet (eip155:59144)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`chainId`*	String	Must be in CAIP-2 format or chain identifier shortcut (e.g. `eip155:10143` or `monad-testnet`).
`includeNfts`	Boolean - Defaults to `false`	Optionally includes the NFTs of the client on the specified chain.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the chain with a valid chain value.

curl --request GET \
  --url 'https://api.portalhq.io/api/v3/clients/me/chains/[chain]/assets' \
  --header 'Authorization: Bearer [token]'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "nativeBalance": {
    "balance": "0.10991767582513721",
    "decimals": 18,
    "name": "Ether",
    "rawBalance": "109917675825137210",
    "symbol": "ETH",
    "metadata": {
      "logo": "https://cdn.moralis.io/eth/0x.png",
      "thumbnail": "https://cdn.moralis.io/eth/0x_thumb.png"
    }
  },
  "tokenBalances": [
    {
      "balance": "0.0199",
      "decimals": 18,
      "name": "Wrapped Ether",
      "rawBalance": "19900000000000000",
      "symbol": "WETH",
      "metadata": {
        "tokenAddress": "0xfff9976782d46cc05630d1f6ebab18b2324d6b14",
        "verifiedContract": false,
        "totalSupply": "48148.648311179713152621",
        "rawTotalSupply": "48148648311179713152621",
        "percentageRelativeToTotalSupply": 0.00004133033989114
      }
    }
  ],
  "nfts": [
    {
      "nftId": "ethereum.0x123abc...def456.1234",
      "name": "Cosmic Kitty #1234",
      "description": "A rare, interstellar feline NFT from the Cosmic Kitties collection.",
      "imageUrl": "https://example.com/images/cosmic-kitty-1234.png",
      "chainId": "eip155:1",
      "contractAddress": "0x123abc...def456",
      "tokenId": "1234",
      "collection": {
        "name": "Cosmic Kitties",
        "description": "A collection of 10,000 unique space-faring felines.",
        "imageUrl": "https://example.com/images/cosmic-kitties-logo.png"
      },
      "lastSale": {
        "price": 1500000000000000000,
        "currency": "ETH",
        "date": "2024-07-15T14:30:00Z"
      },
      "rarity": {
        "rank": 42,
        "score": 0.95
      },
      "floorPrice": {
        "price": 1200000000000000000,
        "currency": "ETH"
      },
      "detailedInfo": {
        "ownerCount": 1,
        "tokenCount": 1,
        "createdDate": "2024-01-01T00:00:00Z",
        "attributes": [
          {
            "traitType": "Fur Color",
            "value": "Nebula Purple",
            "displayType": null
          },
          {
            "traitType": "Eye Color",
            "value": "Starlight Blue",
            "displayType": null
          },
          {
            "traitType": "Accessory",
            "value": "Jetpack",
            "displayType": null
          }
        ],
        "owners": [
          {
            "ownerAddress": "0xabcdef...123456",
            "quantity": 1,
            "firstAcquiredDate": "2024-07-15T14:30:00Z",
            "lastAcquiredDate": "2024-07-15T14:30:00Z"
          }
        ],
        "extendedCollectionInfo": {
          "bannerImageUrl": "https://example.com/images/cosmic-kitties-banner.png",
          "externalUrl": "https://cosmickitties.io",
          "twitterUsername": "@CosmicKitties",
          "discordUrl": "https://discord.gg/cosmickitties",
          "instagramUsername": "@cosmic.kitties",
          "mediumUsername": "@CosmicKittiesNFT",
          "telegramUrl": "https://t.me/cosmickitties",
          "distinctOwnerCount": 8500,
          "distinctNftCount": 10000,
          "totalQuantity": 10000
        },
        "extendedSaleInfo": {
          "fromAddress": "0x98765...fedcba",
          "toAddress": "0xabcdef...123456",
          "priceUsdCents": 270000,
          "transaction": "0xfedcba...987654",
          "marketplaceId": "opensea",
          "marketplaceName": "OpenSea"
        },
        "marketplaceInfo": [
          {
            "marketplaceId": "opensea",
            "marketplaceName": "OpenSea",
            "marketplaceCollectionId": "cosmic-kitties",
            "nftUrl": "https://opensea.io/assets/ethereum/0x123abc...def456/1234",
            "collectionUrl": "https://opensea.io/collection/cosmic-kitties",
            "verified": true,
            "floorPrice": {
              "value": 1200000000000000000,
              "paymentToken": {
                "paymentTokenId": "ethereum",
                "name": "Ethereum",
                "symbol": "ETH",
                "address": null,
                "decimals": 18
              },
              "valueUsdCents": 270000
            }
          }
        ],
        "mediaInfo": {
          "previews": {
            "imageSmallUrl": "https://example.com/images/cosmic-kitty-1234-small.png",
            "imageMediumUrl": "https://example.com/images/cosmic-kitty-1234-medium.png",
            "imageLargeUrl": "https://example.com/images/cosmic-kitty-1234-large.png",
            "imageOpengraphUrl": "https://example.com/images/cosmic-kitty-1234-og.png",
            "blurhash": "L9B4IwofV@of~qofM{of00WB%Mj[",
            "predominantColor": "#8A2BE2"
          },
          "animationUrl": "https://example.com/animations/cosmic-kitty-1234.mp4",
          "backgroundColor": "#000000"
        }
      }
    }
  ]
}

Get the client’s assets by chain (NFTs only)

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 or ethereum)
Ethereum Sepolia (eip155:11155111 or sepolia)
Base Mainnet (eip155:8453 or base)
Base Sepolia (eip155:84532 or base-sepolia)
Polygon Mainnet (eip155:137 or polygon)
Polygon Amoy (eip155:80002 or polygon-amoy)
Optimism Mainnet (eip155:10)
Binance Smart Chain (eip155:56)
Binance Smart Chain Testnet (eip155:97)
Fantom (eip155:250)
Moonbeam (eip155:1284)
Arbitrum Mainnet (eip155:42161)
Avalanche Mainnet (eip155:43114)
Linea Mainnet (eip155:59144)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`chainId`*	String	Must be in CAIP-2 format or chain identifier shortcut (e.g. `eip155:10143` or `monad-testnet`).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the chain with a valid chain value.

curl --request GET \
  --url https://api.portalhq.io/api/v3/clients/me/chains/[chain]/assets/nfts \
  --header 'Authorization: Bearer [token]'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

[
  {
    "nftId": "ethereum.0x123abc...def456.1234",
    "name": "Cosmic Kitty #1234",
    "description": "A rare, interstellar feline NFT from the Cosmic Kitties collection.",
    "imageUrl": "https://example.com/images/cosmic-kitty-1234.png",
    "chainId": "eip155:1",
    "contractAddress": "0x123abc...def456",
    "tokenId": "1234",
    "collection": {
      "name": "Cosmic Kitties",
      "description": "A collection of 10,000 unique space-faring felines.",
      "imageUrl": "https://example.com/images/cosmic-kitties-logo.png"
    },
    "lastSale": {
      "price": 1500000000000000000,
      "currency": "ETH",
      "date": "2024-07-15T14:30:00Z"
    },
    "rarity": {
      "rank": 42,
      "score": 0.95
    },
    "floorPrice": {
      "price": 1200000000000000000,
      "currency": "ETH"
    },
    "detailedInfo": {
      "ownerCount": 1,
      "tokenCount": 1,
      "createdDate": "2024-01-01T00:00:00Z",
      "attributes": [
        {
          "traitType": "Fur Color",
          "value": "Nebula Purple",
          "displayType": null
        },
        {
          "traitType": "Eye Color",
          "value": "Starlight Blue",
          "displayType": null
        },
        {
          "traitType": "Accessory",
          "value": "Jetpack",
          "displayType": null
        }
      ],
      "owners": [
        {
          "ownerAddress": "0xabcdef...123456",
          "quantity": 1,
          "firstAcquiredDate": "2024-07-15T14:30:00Z",
          "lastAcquiredDate": "2024-07-15T14:30:00Z"
        }
      ],
      "extendedCollectionInfo": {
        "bannerImageUrl": "https://example.com/images/cosmic-kitties-banner.png",
        "externalUrl": "https://cosmickitties.io",
        "twitterUsername": "@CosmicKitties",
        "discordUrl": "https://discord.gg/cosmickitties",
        "instagramUsername": "@cosmic.kitties",
        "mediumUsername": "@CosmicKittiesNFT",
        "telegramUrl": "https://t.me/cosmickitties",
        "distinctOwnerCount": 8500,
        "distinctNftCount": 10000,
        "totalQuantity": 10000
      },
      "extendedSaleInfo": {
        "fromAddress": "0x98765...fedcba",
        "toAddress": "0xabcdef...123456",
        "priceUsdCents": 270000,
        "transaction": "0xfedcba...987654",
        "marketplaceId": "opensea",
        "marketplaceName": "OpenSea"
      },
      "marketplaceInfo": [
        {
          "marketplaceId": "opensea",
          "marketplaceName": "OpenSea",
          "marketplaceCollectionId": "cosmic-kitties",
          "nftUrl": "https://opensea.io/assets/ethereum/0x123abc...def456/1234",
          "collectionUrl": "https://opensea.io/collection/cosmic-kitties",
          "verified": true,
          "floorPrice": {
            "value": 1200000000000000000,
            "paymentToken": {
              "paymentTokenId": "ethereum",
              "name": "Ethereum",
              "symbol": "ETH",
              "address": null,
              "decimals": 18
            },
            "valueUsdCents": 270000
          }
        }
      ],
      "mediaInfo": {
        "previews": {
          "imageSmallUrl": "https://example.com/images/cosmic-kitty-1234-small.png",
          "imageMediumUrl": "https://example.com/images/cosmic-kitty-1234-medium.png",
          "imageLargeUrl": "https://example.com/images/cosmic-kitty-1234-large.png",
          "imageOpengraphUrl": "https://example.com/images/cosmic-kitty-1234-og.png",
          "blurhash": "L9B4IwofV@of~qofM{of00WB%Mj[",
          "predominantColor": "#8A2BE2"
        },
        "animationUrl": "https://example.com/animations/cosmic-kitty-1234.mp4",
        "backgroundColor": "#000000"
      }
    }
  }
]

Get the client’s Solana transaction history

GET https://api.portalhq.io/api/v3/clients/me/chains/:chain/transactions Retrieves the client’s transaction history for a specific chain.

Supported Chains

Solana Mainnet (solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp or solana)
Solana Devnet (solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1 or solana-devnet)

You can find the EVM Portal client transaction history endpoint here.

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Path Parameters

Name	Type	Description
`chain`*	String	Must be in CAIP-2 format or chain identifier shortcut (e.g. `eip155:10143` or `monad-testnet`).

Query Parameters

Name	Type	Description
`limit`	Number	The max amount of transactions returned in the request. Defaults to `1000`.
`offset`	Number	The number of transactions to skip before returning results. Used for pagination when combined with the limit parameter. Defaults to `0`.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the chain with a valid chain value.

curl --request GET \
  --url https://api.portalhq.io/api/v3/clients/me/chains/[chain]/transactions \
  --header 'Authorization: Bearer [token]'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "data": {
    "transactions": [
      {
        "blockTime": 1741126345,
        "error": null,
        "signature": "3J7cMNTCks3dNmVZsivgGcQzdTS7hr5Y8Na4Rb1yLdP9JPcPBHPjvVRQUtLzfdgUDiLZZhgBwPebXGdZz3ueuH4k",
        "status": "finalized",
        "tokenMint": null, // Used to identify SPL token (null for SOL txs)
        "transactionDetails": {
          "transaction": {
            "message": {
              "accountKeys": [
                "VgogDdrRWZxQxSMxWy3wEJPij5ZvRxV9C9dp4k1fGrx",
                "75ZfLXXsSpycDvHTQuHnGQuYgd2ihb6Bu4viiCCQ7P4H",
                "11111111111111111111111111111111"
              ],
              "header": {
                "numReadonlySignedAccounts": 0,
                "numReadonlyUnsignedAccounts": 1,
                "numRequiredSignatures": 1
              },
              "instructions": [
                {
                  "accounts": [
                    0,
                    1
                  ],
                  "data": "3Bxs4Bc3VYuGVB19",
                  "programIdIndex": 2,
                  "stackHeight": null
                }
              ],
              "recentBlockhash": "94x5LakBUZwcnpprYuftki9mq22dC353yebkoxLjhJqt"
            },
            "signatures": [
              "3J7cMNTCks3dNmVZsivgGcQzdTS7hr5Y8Na4Rb1yLdP9JPcPBHPjvVRQUtLzfdgUDiLZZhgBwPebXGdZz3ueuH4k"
            ]
          },
          "signatureDetails": {
            "blockTime": 1741126345,
            "confirmationStatus": "finalized",
            "error": null,
            "memo": null,
            "signature": "3J7cMNTCks3dNmVZsivgGcQzdTS7hr5Y8Na4Rb1yLdP9JPcPBHPjvVRQUtLzfdgUDiLZZhgBwPebXGdZz3ueuH4k",
            "slot": 365141926
          },
          "metadata": {
            "blockTime": 1741126345,
            "slot": 365141926,
            "error": null,
            "fee": 5000,
            "innerInstructions": [],
            "loadedAddresses": {
              "readonly": [],
              "writable": []
            },
            "logMessages": [
              "Program 11111111111111111111111111111111 invoke [1]",
              "Program 11111111111111111111111111111111 success"
            ],
            "postBalances": [
              7990000,
              9610486252,
              1
            ],
            "postTokenBalances": [],
            "preBalances": [
              8995000,
              9609486252,
              1
            ],
            "preTokenBalances": [],
            "rewards": [],
            "status": {
              "Ok": null
            },
            "version": "legacy"
          }
        }
      }
    ]
  },
  "metadata": {
    "address": "clientSolanaAddress",
    "chainId": "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1",
    "clientId": "clientId",
    "limit": null, // Defaults to 1000
    "offset": 0
  }
}

Get the client’s EIP-155 transaction history

GET https://api.portalhq.io/api/v3/clients/me/transactions Retrieves the client’s transaction history for a specific chain.

Supported Chains

Monad Testnet (eip155:10143)
Ethereum Mainnet (eip155:1)
Ethereum Sepolia (eip155:11155111)
Base Mainnet (eip155:8453)
Base Sepolia (eip155:84532)
Polygon Mainnet (eip155:137)
Polygon Mumbai (eip155:80001)
Polygon Amoy (eip155:80002)
Arbitrum (eip155:42161)
Arbitrum Sepolia (eip155:421614)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`chainId`*	String	Must be in CAIP-2 format (e.g. `"eip155:10143"`).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the chain with a valid chain value.

curl --request GET \
  --url 'https://api.portalhq.io/api/v3/clients/me/transactions?chainId=[chain]' \
  --header 'Authorization: Bearer [token]'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

[
  {
    "blockNum": "0x57450c",
    "uniqueId": "0x3b8a06c63d02ba6826cce6188c2caa44b68dd6a36050dcfd5c085a7cba5444e3:external",
    "hash": "0x3b8a06c63d02ba6826cce6188c2caa44b68dd6a36050dcfd5c085a7cba5444e3",
    "from": "0xdfd8302f44727a6348f702ff7b594f127de3a902",
    "to": "0x8eddb4067a73061e93583897d4684b749a93f19c",
    "value": 0.01,
    "erc721TokenId": null,
    "erc1155Metadata": null,
    "tokenId": null,
    "asset": "ETH",
    "category": "external",
    "rawContract": {
      "value": "0x2386f26fc10000",
      "address": null,
      "decimal": "0x12"
    },
    "metadata": {
      "blockTimestamp": "2024-04-17T17:32:24.000Z"
    },
    "chainId": 11155111
  }
]

Fund wallet with testnet tokens

POST https://api.portalhq.io/api/v3/clients/me/fund Sends testnet tokens to your Portal client’s wallet.

Supported Chains

Monad Testnet (eip155:10143)
- Up to 0.01 MON per Portal client per 24 hours.
Ethereum Sepolia (eip155:11155111)
- Up to 0.01 ETH per Portal client per 24 hours.
Celo Alfajores (eip155:44787)
- Up to 0.1 CELO per Portal client per 24 hours.
Solana Devnet (solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1)
- Up to 0.01 SOL per Portal client per 24 hours.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`chainId`*	String	The CAIP-2 chainId you want to receive testnet tokens on.
`token`*	String	The testnet token you want to receive.
`amount`*	String	The amount to transfer (as a string, in the token’s primary denomination).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the chain with a valid chain value.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/fund \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "chainId": "eip155:10143",
  "token": "MON",
  "amount": "0.01"
}
'

Example Response

200: EIP-155 Response
429: Too Many Requests

{
  "data": {
    "explorerUrl": "https://testnet.monadexplorer.com/tx/0x93d1eb05b151ed66aabdd09e7151bbf19037e1b414565ce64968f58c138995dc",
    "txHash": "0x93d1eb05b151ed66aabdd09e7151bbf19037e1b414565ce64968f58c138995dc"
  },
  "metadata": {
    "amount": "0.01",
    "chainId": "eip155:10143",
    "clientId": "clientId",
    "custodianId": "custodianId",
    "environmentId": "environmentId",
    "token": "NATIVE"
  }
}

Build a transaction

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-2 chainId):
- monad-testnet (eip155:10143)
- ethereum (eip155:1)
- sepolia (eip155:11155111)
- base (eip155:8453)
- base-sepolia (eip155:84532)
- polygon (eip155:137)
- polygon-mumbai (eip155:80001)
- celo (eip155:42220)
- celo-alfajores (eip155:44787)
- solana (solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp)
- solana-devnet (solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1)
- tron (tron:mainnet)
- tron-nile (tron:nile)
- tron-shasta (tron:shasta)
- stellar (stellar:pubnet)
- stellar-testnet (stellar:testnet)
- bitcoin-segwit (bip122:000000000019d6689c085ae165831e93-p2wpkh)
- bitcoin-segwit-testnet (bip122:000000000933ea01ad0ee984209779ba-p2wpkh)
- bitcoin-p2wpkh (bip122:000000000019d6689c085ae165831e93-p2wpkh)
- bitcoin-p2wpkh-testnet (bip122:000000000933ea01ad0ee984209779ba-p2wpkh)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Path Parameters

Name	Type	Description
`chain`*	String	Must be one of the chains in “Supported Chains”.

Body Parameters

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). For native token transfers, use `"NATIVE"`.
`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

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the chain with a valid chain value.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/chains/[chain]/assets/send/build-transaction \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "to": "0xdFd8302f44727A6348F702fF7B594f127dE3A902",
  "token": "USDC",
  "amount": "0.01"
}'

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).

200: EIP-155 Response
200: Solana Response
200: Bitcoin Response
400: Bad Request

{
  "transaction": {
    "from": "0x54968898742c08da211a1cd355447cd1f37f0649",
    "to": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "data": "0xa9059cbb000000000000000000000000dfd8302f44727a6348f702ff7b594f127de3a9020000000000000000000000000000000000000000000000000000000000002710"
  },
  "metadata": {
    "amount": "0.01",
    "fromAddress": "0x54968898742c08da211a1cd355447cd1f37f0649",
    "toAddress": "0xdFd8302f44727A6348F702fF7B594f127dE3A902",
    "tokenAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "tokenDecimals": 6,
    "rawAmount": "10000"
  }
}

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.

Simulate + validate 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:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`chainId`*	String	Must be in CAIP-2 format (e.g. `eip155:11155111`, `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1`).

Body Parameters

EIP-155
Solana

Name	Type	Description
`to`(Required)	String	The recipient’s address.
`gas`	String	The gas limit provided for the transaction.
`gasPrice`	String	The price per unit of gas the sender is willing to pay.
`maxFeePerGas`	String	The maximum total fee per gas unit the sender is willing to pay.
`maxPriorityFeePerGas`	String	The maximum priority fee per gas unit the sender is willing to pay.
`value`	String	The amount of native token to send with the transaction.
`data`	String	The input data to send with the transaction (used for contract calls).
`operationType`	`"validation"`, `"simulation"`, or `"all"` Default: `"all"`	The operation to perform with the transaction.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the chain with a valid chain value.

curl --request POST \
  --url 'https://api.portalhq.io/api/v3/clients/me/evaluate-transaction?chainId=[chain]' \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "transactions": ["AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAEDMVpKVHpo95fjtP7ysGKoVJSvwe6NDt2DwawHnAa5XccB1aziYgQ4rYMUc0A5K2y4oefHN83MNdiTvNPqWosjPAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAfW0SaDYLd80C2EifQJo2aExTPB0O4Kj02C/U1EleynMBAgIAAQwCAAAAQEIPAAAAAAA=", "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAEDMVpKVHpo95fjtP7ysGKoVJSvwe6NDt2DwawHnAa5XccB1aziYgQ4rYMUc0A5K2y4oefHN83MNdiTvNPqWosjPAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAfW0SaDYLd80C2EifQJo2aExTPB0O4Kj02C/U1EleynMBAgIAAQwCAAAAQEIPAAAAAAA="]
}'

Example Response

200: EIP-155 Success
200: Solana Success
400: Bad Request
401: Unauthorized Request

{
  "chain": "ethereum",
  "validation": {
    "status": "Success",
    "resultType": "Malicious",
    "description": "A known malicious address is involved in the transaction",
    "reason": "raw_ether_transfer",
    "classification": "known_malicious",
    "features": []
  },
  "simulation": {
    "status": "Success",
    "assetsDiffs": {
      "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14": [
        {
          "asset": {
            "type": "NATIVE",
            "chainName": "sepolia",
            "decimals": 18,
            "chainId": 11155111,
            "logoUrl": "https://cdn.blockaid.io/chain/sepolia",
            "name": "Sepolia Ether",
            "symbol": "ETH"
          },
          "in": [
            {
              "summary": "Received 0 ETH",
              "value": "0.000000000000000001",
              "rawValue": "0x1"
            }
          ],
          "out": []
        },
        {
          "asset": {
            "type": "ERC20",
            "address": "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14",
            "logoUrl": "https://cdn.blockaid.io/token/0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14/ethereum-sepolia",
            "decimals": 18,
            "name": "Wrapped Ether",
            "symbol": "WETH"
          },
          "in": [],
          "out": [
            {
              "summary": "Sent 0 WETH",
              "value": "0.000000000000000001",
              "rawValue": "0x1"
            }
          ]
        }
      ],
      "0x31A89E000E9029362213387FEDe26F7B543e9D1C": [
        {
          "asset": {
            "type": "NATIVE",
            "chainName": "sepolia",
            "decimals": 18,
            "chainId": 11155111,
            "logoUrl": "https://cdn.blockaid.io/chain/sepolia",
            "name": "Sepolia Ether",
            "symbol": "ETH"
          },
          "in": [],
          "out": [
            {
              "summary": "Sent 0 ETH",
              "value": "0.000000000000000001",
              "rawValue": "0x1"
            }
          ]
        },
        {
          "asset": {
            "type": "ERC20",
            "address": "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14",
            "logoUrl": "https://cdn.blockaid.io/token/0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14/ethereum-sepolia",
            "decimals": 18,
            "name": "Wrapped Ether",
            "symbol": "WETH"
          },
          "in": [
            {
              "summary": "Received 0 WETH",
              "value": "0.000000000000000001",
              "rawValue": "0x1"
            }
          ],
          "out": []
        }
      ]
    },
    "totalUsdDiff": {},
    "exposures": {},
    "totalUsdExposure": {},
    "addressDetails": {},
    "accountSummary": {
      "assetsDiffs": [
        {
          "asset": {
            "type": "NATIVE",
            "chainName": "sepolia",
            "decimals": 18,
            "chainId": 11155111,
            "logoUrl": "https://cdn.blockaid.io/chain/sepolia",
            "name": "Sepolia Ether",
            "symbol": "ETH"
          },
          "in": [],
          "out": [
            {
              "summary": "Sent 0 ETH",
              "value": "0.000000000000000001",
              "rawValue": "0x1"
            }
          ]
        },
        {
          "asset": {
            "type": "ERC20",
            "address": "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14",
            "logoUrl": "https://cdn.blockaid.io/token/0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14/ethereum-sepolia",
            "decimals": 18,
            "name": "Wrapped Ether",
            "symbol": "WETH"
          },
          "in": [
            {
              "summary": "Received 0 WETH",
              "value": "0.000000000000000001",
              "rawValue": "0x1"
            }
          ],
          "out": []
        }
      ],
      "exposures": [],
      "totalUsdExposure": {}
    }
  }
}

Client Shares

PATCH https://api.portalhq.io/api/v3/clients/me/signing-share-pairs Updates a client’s signing share pairs’ statuses. Intended to be used after successfully storing the client signing share on the client’s device.

Do not use this endpoint if you are using the Portal SDKs. The Portal SDKs already use this endpoint internally for your convenience.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`signingSharePairIds`*	String[]	An array of signing share pair IDs.
`status`*	`"STORED_CLIENT"`	The updated status of the signing share pairs.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request PATCH \
  --url 'https://api.portalhq.io/api/v3/clients/me/signing-share-pairs' \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "signingSharePairIds": ["signingSharePairId1"],
  "status": "STORED_CLIENT"
}'

Example Response

204: Success, No Content
400: Bad Request
401: Unauthorized Request

PATCH https://api.portalhq.io/api/v3/clients/me/backup-share-pairs Updates a client’s backup share pairs’ statuses. Intended to be used after successfully storing the encrypted client backup share.

Do not use this endpoint if you are using the Portal SDKs. The Portal SDKs already use this endpoint internally for your convenience.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`backupSharePairIds`*	String[]	An array of backup share pair IDs.
`status`*	`"STORED_CLIENT_BACKUP_SHARE_KEY"` \| `"STORED_CLIENT_BACKUP_SHARE"`	The updated status of the backup share pairs.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request PATCH \
  --url https://api.portalhq.io/api/v3/clients/me/backup-share-pairs \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "STORED_CLIENT_BACKUP_SHARE",
  "backupSharePairIds": ["backupSharePairId1"]
}
'

Example Response

204: Success, No Content
400: Bad Request
401: Unauthorized Request

PATCH https://api.portalhq.io/api/v3/clients/me/backup-share-pairs/:backupSharePairId Stores a client’s encrypted backup share for Portal-Managed Backups. This endpoint is used when running eject while using the Enclave MPC API with a Portal-Managed Backup configuration. Call this endpoint once for the SECP256K1 share and once for the ED25519 share.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`clientCipherText`*	String	The ciphertext from encrypting a backup share.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the backupSharePairId with the relevant backup share pair ID.

curl --request PATCH \
  --url https://api.portalhq.io/api/v3/clients/me/backup-share-pairs/[backupSharePairId] \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "clientCipherText": "clientBackupShareCipherText"
}
'

Example Response

200: Success
400: Bad Request
401: Unauthorized

GET https://api.portalhq.io/api/v3/clients/me/backup-share-pairs/:backupSharePairId/cipher-text Your custodian must be using Portal-Managed Backups to use this endpoint. Fetches a client’s encrypted backup share for Portal-Managed Backups. This endpoint is used when running eject while using the Enclave MPC API with a Portal-Managed Backup configuration.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the backupSharePairId with the relevant backup share pair ID.

curl --request GET \
  --url https://api.portalhq.io/api/v3/clients/me/backup-share-pairs/[backupSharePairId]/cipher-text \
  --header 'Authorization: Bearer [token]'
'

Example Response

200: Success
400: Bad Request
401: Unauthorized

{
  "cipherText": "0351cf2baa54748662a6c89bb032..."
}

Get the ejectable backup shares for Portal-Managed Backups

GET https://api.portalhq.io/api/v3/clients/me/wallets/:walletId/ejectable-backup-shares You must have made the wallet ejectable before using this endpoint. Your custodian must be using Portal-Managed Backups to use this endpoint. Fetches a client’s encrypted backup share and their custodian backup share. This endpoint is used when running eject while using the Enclave MPC API with a Portal-Managed Backup configuration.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the walletId with the relevant Portal client wallet ID.

curl --request GET \
  --url ttps://api.portalhq.io/api/v3/clients/me/wallets/[walletId]/ejectable-backup-shares \
  --header 'Authorization: Bearer [token]'
'

Example Response

200: Success
400: Bad Request
401: Unauthorized

{
  "encryptedClientBackupShare": "0351cf2baa54748662a6c89bb032...",
  "custodianBackupShare": "{\"backupSharePairId\":\"backupSharePairId\",\"clientBk\":\"clientBk\",\"clientId\":\"clientId\",\"clientPartialPubKey_x\":\"clientPartialPubKey_x\",\"clientPartialPubKey_y\":\"clientPartialPubKey_y\",\"pailler_p\":\"pailler_p\",\"pailler_q\":\"pailler_q\",\"pedersenClient_n\":\"pedersenClient_n\",\"pedersenClient_s\":\"pedersenClient_s\",\"pedersenClient_t\":\"pedersenClient_t\",\"pedersenServer_n\":\"pedersenServer_n\",\"pedersenServer_s\":\"pedersenServer_s\",\"pedersenServer_t\":\"pedersenServer_t\",\"serverBk\":\"serverBk\",\"serverPartialPubKey_x\":\"serverPartialPubKey_x\",\"serverPartialPubKey_y\":\"serverPartialPubKey_y\",\"share\":\"share\",\"ssid\":\"ssid",\"x\":\"x\",\"y\":\"y\",\"yClient_x\":\"yClient_x\",\"yClient_y\":\"yClient_y\",\"yServer_x\":\"yServer_x\",\"yServer_y\":\"yServer_y\"}"
}

Swaps

For all swap endpoints, you will need to provide a 0x API key. You can get one by signing up for a 0x account here.

Get available swap sources

POST https://api.portalhq.io/api/v3/clients/me/chains/:chain/assets/swap/sources This endpoint retrieves the available swap sources for a specific chain.

Supported Chains

Ethereum (eip155:1)
Monad Testnet (eip155:10143)
Base (eip155:8453)
Arbitrum (eip155:42161)
Optimism (eip155:10)
Avalanche (eip155:43114)
Polygon (eip155:137)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Path Parameters

Name	Type	Description
`chain`*	String	Must be one of the chains in “Supported Chains”.

Body Parameters

Name	Type	Description
`zeroXApiKey`*	String	Your 0x API key for swap functionality.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token, the chain with a valid chain value, and the zeroXApiKey with your 0x API key.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/chains/[chain]/assets/swap/sources \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "zeroXApiKey": "your-0x-api-key"
}'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "data": {
    "sources": [
      "0x_RFQ",
      "Ambient",
      "Angle",
      "Balancer_V1",
      "Balancer_V2",
      "Balancer_V3",
      "Bancor_V3",
      "Curve",
      "DODO_V1",
      "DODO_V2",
      "DeFi_Swap",
      "Ekubo",
      "Fluid",
      "Fraxswap_V2",
      "Integral",
      "Lido",
      "Maker_PSM",
      "Maverick",
      "Maverick_V2",
      "Origin",
      "PancakeSwap_V2",
      "PancakeSwap_V3",
      "Polygon_Migration",
      "RingSwap",
      "RocketPool",
      "ShibaSwap",
      "Sky_Migration",
      "Solidly_V3",
      "Spark",
      "Stepn",
      "SushiSwap",
      "SushiSwap_V3",
      "Swaap_V2",
      "Synapse",
      "Uniswap_V2",
      "Uniswap_V3",
      "Uniswap_V4",
      "Yearn",
      "Yearn_V3"
    ]
  },
  "metadata": {
    "chainId": "eip155:1",
    "clientId": "clientId"
  }
}

Get swap quote

POST https://api.portalhq.io/api/v3/clients/me/chains/:chain/assets/swap/quote This endpoint retrieves a swap quote for trading tokens on a specific chain.

Supported Chains

Ethereum (eip155:1)
Monad Testnet (eip155:10143)
Base (eip155:8453)
Arbitrum (eip155:42161)
Optimism (eip155:10)
Avalanche (eip155:43114)
Polygon (eip155:137)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Path Parameters

Name	Type	Description
`chain`*	String	Must be one of the chains in “Supported Chains”.

Body Parameters

Name	Type	Description
`zeroXApiKey`*	String	Your 0x API key for swap functionality.
`buyToken`*	String	The token symbol you want to buy (e.g., “ETH”, “USDC”, “0x123abc”).
`sellToken`*	String	The token symbol you want to sell (e.g., “ETH”, “USDC”, “0x123abc”).
`sellAmount`*	String	The amount to sell (in wei for ETH, or smallest unit for tokens).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token, the chain with a valid chain value, and the zeroXApiKey with your 0x API key.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/chains/[chain]/assets/swap/quote \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "zeroXApiKey": "your-0x-api-key",
  "buyToken": "USDC",
  "sellToken": "ETH",
  "sellAmount": "100000000000000000000000"
}'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "data": {
    "quote": {
      "blockNumber": "23141056",
      "buyAmount": "229323843620790",
      "buyToken": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "fees": {
        "integratorFee": null,
        "zeroExFee": {
          "amount": "327336997106",
          "token": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
          "type": "volume"
        },
        "gasFee": null
      },
      "issues": {
        "allowance": null,
        "balance": {
          "token": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
          "actual": "0",
          "expected": "100000000000000000000000"
        },
        "simulationIncomplete": false,
        "invalidSourcesPassed": []
      },
      "liquidityAvailable": true,
      "minBuyAmount": "227027160159390",
      "route": {
        "fills": [
          {
            "from": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
            "to": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599",
            "source": "Uniswap_V3",
            "proportionBps": "250"
          }
        ],
        "tokens": [
          {
            "address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
            "symbol": "WETH"
          },
          {
            "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "symbol": "USDC"
          }
        ]
      },
      "sellAmount": "100000000000000000000000",
      "sellToken": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
      "tokenMetadata": {
        "buyToken": {
          "buyTaxBps": "0",
          "sellTaxBps": "0"
        },
        "sellToken": {
          "buyTaxBps": "0",
          "sellTaxBps": "0"
        }
      },
      "totalNetworkFee": "134465938444220308",
      "transaction": {
        "to": "0x0000000000001ff3684f28c67538d4d072c22734",
        "data": "0x2213bc0b...",
        "gas": "0x44e949c",
        "gasPrice": "0x6eeb0413",
        "value": "0x152d02c7e14af6000000",
        "from": "0x2B8C2DDC4207D1335F375af6129f102CA6ddA351"
      }
    }
  },
  "metadata": {
    "buyToken": "USDC",
    "chainId": "eip155:1",
    "clientEip155Address": "0x2B8C2DDC4207D1335F375af6129f102CA6ddA351",
    "clientId": "clientId",
    "sellAmount": "100000000000000000000000",
    "sellToken": "ETH"
  }
}

Get swap price

POST https://api.portalhq.io/api/v3/clients/me/chains/:chain/assets/swap/price This endpoint retrieves a swap price for trading tokens on a specific chain without building a transaction.

Supported Chains

Ethereum (eip155:1)
Monad Testnet (eip155:10143)
Base (eip155:8453)
Arbitrum (eip155:42161)
Optimism (eip155:10)
Avalanche (eip155:43114)
Polygon (eip155:137)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Path Parameters

Name	Type	Description
`chain`*	String	Must be one of the chains in “Supported Chains”.

Body Parameters

Name	Type	Description
`zeroXApiKey`*	String	Your 0x API key for swap functionality.
`buyToken`*	String	The token symbol you want to buy (e.g., “ETH”, “USDC”, “0x123abc”).
`sellToken`*	String	The token symbol you want to sell (e.g., “ETH”, “USDC”, “0x123abc”).
`sellAmount`*	String	The amount to sell (in wei for ETH, or smallest unit for tokens).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token, the chain with a valid chain value, and the zeroXApiKey with your 0x API key.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/chains/[chain]/assets/swap/price \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "zeroXApiKey": "your-0x-api-key",
  "buyToken": "USDC",
  "sellToken": "USDT",
  "sellAmount": "100000000000000000000000"
}'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "data": {
    "price": {
      "blockNumber": "23141060",
      "buyAmount": "85682951516470",
      "buyToken": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "fees": {
        "integratorFee": null,
        "zeroExFee": {
          "amount": "128717503532",
          "token": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
          "type": "volume"
        },
        "gasFee": null
      },
      "gas": "352147",
      "gasPrice": "1844071753",
      "issues": {
        "allowance": {
          "actual": "0",
          "spender": "0x0000000000001ff3684f28c67538d4d072c22734"
        },
        "balance": {
          "token": "0xdac17f958d2ee523a2206206994597c13d831ec7",
          "actual": "0",
          "expected": "100000000000000000000000"
        },
        "simulationIncomplete": false,
        "invalidSourcesPassed": []
      },
      "liquidityAvailable": true,
      "minBuyAmount": "84824834826270",
      "route": {
        "fills": [
          {
            "from": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "to": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "source": "Curve",
            "proportionBps": "10000"
          }
        ],
        "tokens": [
          {
            "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "symbol": "USDT"
          },
          {
            "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "symbol": "USDC"
          }
        ]
      },
      "sellAmount": "100000000000000000000000",
      "sellToken": "0xdac17f958d2ee523a2206206994597c13d831ec7",
      "tokenMetadata": {
        "buyToken": {
          "buyTaxBps": "0",
          "sellTaxBps": "0"
        },
        "sellToken": {
          "buyTaxBps": "0",
          "sellTaxBps": "0"
        }
      },
      "totalNetworkFee": "649384335603691"
    }
  },
  "metadata": {
    "buyToken": "USDC",
    "chainId": "eip155:1",
    "clientEip155Address": "0x2B8C2DDC4207D1335F375af6129f102CA6ddA351",
    "clientId": "clientId",
    "sellAmount": "100000000000000000000000",
    "sellToken": "USDT"
  }
}

Yield.xyz Integration

Get yield opportunities

GET https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/yields This proxy endpoint retrieves a paginated list of available yield opportunities across all supported networks and protocols. View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`offset`	Number	Number of results to skip (for pagination). Defaults to `0`.
`limit`	Number	Maximum number of results to return. Defaults to `100`.
`network`	String	Network identifier in CAIP-2 format (e.g., `eip155:1` for Ethereum).
`networks`	String[]	Array of network identifiers in CAIP-2 format.
`yieldId`	String	Specific yield opportunity ID.
`yieldIds`	String[]	Array of specific yield opportunity IDs.
`type`	String	Type of yield mechanism (`staking`, `restaking`, `lending`, `vault`, `fixed_yield`, `real_world_asset`).
`types`	String[]	Array of yield mechanism types.
`hasCooldownPeriod`	Boolean	Filter by cooldown period requirement.
`hasWarmupPeriod`	Boolean	Filter by warmup period requirement.
`token`	String	Token contract address to filter by.
`inputToken`	String	Input token symbol or address.
`inputTokens`	String[]	Array of input token symbols or addresses.
`provider`	String	Protocol provider (e.g., `aave`, `compound`).
`providers`	String[]	Array of protocol providers.
`search`	String	Search term for yield opportunities.
`sort`	String	Sorting criteria (`statusEnterAsc`, `statusEnterDesc`, `statusExitAsc`, `statusExitDesc`).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request GET \
  --url 'https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/yields?network=eip155:1&limit=10' \
  --header 'Authorization: Bearer [token]'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"items": [
				{
					"id": "ethereum-sepolia-link-aave-v3-lending",
					"network": "eip155:11155111",
					"inputTokens": [
						{
							"address": "0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5",
							"symbol": "LINK",
							"name": "LINK",
							"decimals": 18,
							"logoURI": "https://assets.stakek.it/tokens/link.svg",
							"network": "eip155:11155111",
							"isPoints": false
						}
					],
					"token": {
						"address": "0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5",
						"symbol": "LINK",
						"name": "LINK",
						"decimals": 18,
						"logoURI": "https://assets.stakek.it/tokens/link.svg",
						"network": "eip155:11155111",
						"isPoints": false
					},
					"rewardRate": {
						"total": 3.574817174889355,
						"rateType": "APY",
						"components": [
							{
								"rate": 3.574817174889355,
								"rateType": "APY",
								"token": {
									"address": "0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5",
									"symbol": "LINK",
									"name": "LINK",
									"decimals": 18,
									"logoURI": "https://assets.stakek.it/tokens/link.svg",
									"network": "eip155:11155111",
									"isPoints": false
								},
								"yieldSource": "lending_interest",
								"description": "Earn lending rewards by supplying LINK"
							}
						]
					},
					"status": {
						"enter": true,
						"exit": true
					},
					"metadata": {
						"name": "Aave v3 Lending",
						"description": "Lend your LINK with Aave v3",
						"documentation": "https://docs.yield.xyz/docs/aave-lending",
						"logoURI": "https://assets.stakek.it/tokens/link.svg",
						"underMaintenance": false,
						"deprecated": false,
						"supportedStandards": []
					},
					"mechanics": {
						"type": "lending",
						"requiresValidatorSelection": false,
						"rewardSchedule": "block",
						"rewardClaiming": "auto",
						"gasFeeToken": {
							"symbol": "ETH",
							"name": "Ethereum",
							"decimals": 18,
							"logoURI": "https://assets.stakek.it/tokens/eth.svg",
							"coinGeckoId": "ethereum",
							"network": "eip155:11155111",
							"isPoints": false
						},
						"entryLimits": {
							"minimum": "0",
							"maximum": null
						},
						"supportsLedgerWalletApi": true,
						"arguments": {
							"enter": {
								"fields": [
									{
										"name": "amount",
										"type": "string",
										"label": "Amount",
										"description": "Enter the amount of tokens to stake, unstake, or transact with. Must be a valid decimal number.",
										"required": true,
										"placeholder": "0.0",
										"minimum": "0",
										"maximum": null,
										"isArray": false
									}
								]
							},
							"exit": {
								"fields": [
									{
										"name": "amount",
										"type": "string",
										"label": "Amount",
										"description": "Enter the amount of tokens to stake, unstake, or transact with. Must be a valid decimal number.",
										"required": true,
										"placeholder": "0.0",
										"minimum": "0",
										"maximum": null,
										"isArray": false
									}
								]
							}
						},
						"possibleFeeTakingMechanisms": {
							"depositFee": true,
							"managementFee": true,
							"performanceFee": true,
							"validatorRebates": false
						}
					},
					"providerId": "aave",
					"outputToken": {
						"address": "0x3FfAf50D4F4E96eB78f2407c090b72e86eCaed24",
						"symbol": "aEthLINK",
						"name": "Aave Ethereum LINK",
						"decimals": 18,
						"logoURI": "https://assets.stakek.it/tokens/alink.svg",
						"network": "eip155:11155111",
						"isPoints": false
					},
					"tags": [
						"lending",
						"LINK",
						"ethereum-sepolia",
						"aave",
						"auto-compounding"
					]
				}
			],
			"total": 1,
			"offset": 0,
			"limit": 10
		}
	}
}

Get yield balances

POST https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/yields/balances This endpoint retrieves balances for multiple wallet addresses across different networks and yield opportunities. View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`queries`*	Array	Array of balance query objects.
`queries[].address`*	String	Wallet address to query balances for.
`queries[].network`*	String	Network identifier in CAIP-2 format (e.g., `eip155:1` for Ethereum).
`queries[].yieldId`	String	Optional specific yield opportunity ID to query.
`queries[].arguments`	Object	Optional arguments for the yield position. (View the original Yield.xyz API endpoint for available arguments here)

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/yields/balances \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "queries": [
    {
      "address": "0x1234567890123456789012345678901234567890",
      "network": "eip155:1"
    }
  ]
}'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"items": [
				{
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"balances": [
						{
							"address": "0xd40e87bf6d8de3d330fd0284190ba24fd8701f69",
							"amount": "0.001000027202065699",
							"amountRaw": "1000027202065699",
							"type": "active",
							"token": {
								"address": "0x3FfAf50D4F4E96eB78f2407c090b72e86eCaed24",
								"symbol": "aEthLINK",
								"name": "Aave Ethereum LINK",
								"decimals": 18,
								"logoURI": "https://assets.stakek.it/tokens/alink.svg",
								"network": "eip155:11155111",
								"isPoints": false
							},
							"pendingActions": [
								{
									"intent": "manage",
									"type": "WITHDRAW",
									"passthrough": "eyJhZGRyZXNzZXMiOnsiYWRkcmVzcyI6IjB4ZDQwZTg3YmY2ZDhkZTNkMzMwZmQwMjg0MTkw...",
									"arguments": null
								}
							],
							"amountUsd": "0.000000",
							"isEarning": true
						}
					]
				}
			],
			"errors": []
		}
	}
}

Enter yield position

POST https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter This endpoint creates an action to enter a yield position. View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`yieldId`*	String	The yield opportunity ID to enter.
`address`*	String	The wallet address to use for the yield position.
`arguments`	Object	Optional arguments for the yield entry. View the original Yield.xyz API endpoint for available arguments here

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/enter \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
	"address": "0xYourAddress",
	"arguments": {
		"amount": "0.001"
	},
	"yieldId": "ethereum-sepolia-link-aave-v3-lending"
}'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"id": "eab173d0-4bf2-45f0-923b-558ef8c35ae9",
			"intent": "enter",
			"type": "STAKE",
			"yieldId": "ethereum-sepolia-link-aave-v3-lending",
			"address": "0xeeb97bd9967ab693443f07fd2cc0b640c72c5696",
			"amount": "0.001",
			"amountRaw": "1000000000000000",
			"amountUsd": null,
			"transactions": [
				{
					"id": "a9e3480f-73a7-4342-905c-b841192f8bcd",
					"title": "APPROVAL Transaction",
					"network": "eip155:11155111",
					"status": "SKIPPED",
					"type": "APPROVAL",
					"hash": null,
					"createdAt": "2025-10-27T17:52:10.437Z",
					"broadcastedAt": null,
					"signedTransaction": null,
					"unsignedTransaction": "{\"from\":\"0xEeB97bD9967AB693443F07Fd2CC0B640C72C5696\",\"gasLimit\":\"0x733c\",\"to\":\"0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5\",\"data\":\"0x095ea7b30000000000000000000000006ae43d3271ff6888e7fc43fd7321a503ff73895100000000000000000000000000000000000000000000000000038d7ea4c68000\",\"nonce\":9,\"type\":2,\"maxFeePerGas\":\"0x0f4252\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
					"stepIndex": 0,
					"gasEstimate": "{\"amount\":\"0.000000059000531000\",\"gasLimit\":\"29500\",\"token\":{\"network\":\"eip155:11155111\",\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"decimals\":18,\"coinGeckoId\":\"ethereum\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\"}}"
				},
				{
					"id": "08955152-90da-4458-8dea-c7b4ac6c325a",
					"title": "SUPPLY Transaction",
					"network": "eip155:11155111",
					"status": "CREATED",
					"type": "SUPPLY",
					"hash": null,
					"createdAt": "2025-10-27T17:52:10.437Z",
					"broadcastedAt": null,
					"signedTransaction": null,
					"unsignedTransaction": "{\"from\":\"0xEeB97bD9967AB693443F07Fd2CC0B640C72C5696\",\"gasLimit\":\"0x02a9a5\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x617ba037000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000eeb97bd9967ab693443f07fd2cc0b640c72c56960000000000000000000000000000000000000000000000000000000000000000\",\"nonce\":9,\"type\":2,\"maxFeePerGas\":\"0x0f4252\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
					"stepIndex": 1,
					"gasEstimate": "{\"amount\":\"0.000000349005141018\",\"gasLimit\":\"174501\",\"token\":{\"network\":\"eip155:11155111\",\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"decimals\":18,\"coinGeckoId\":\"ethereum\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\"}}"
				}
			],
			"executionPattern": "synchronous",
			"rawArguments": null,
			"createdAt": "2025-10-27T17:52:10.437Z",
			"completedAt": null,
			"status": "CREATED"
		}
	}
}

Exit yield position

POST https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/exit This endpoint creates an action to exit a yield position. View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`yieldId`*	String	The yield opportunity ID to exit.
`address`*	String	The wallet address that holds the yield position.
`arguments`	Object	Optional arguments for the yield exit. View the original Yield.xyz API endpoint for available arguments here

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/exit \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
	"yieldId": "ethereum-sepolia-link-aave-v3-lending",
	"address": "0xYourAddress",
	"arguments": {
    "amount": "0.001"
  }
}'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"id": "8dfdea4b-dec1-4222-a1b4-fa98bde5f77a",
			"intent": "exit",
			"type": "UNSTAKE",
			"yieldId": "ethereum-sepolia-link-aave-v3-lending",
			"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
			"amount": "0.001",
			"amountRaw": "1000000000000000",
			"amountUsd": null,
			"transactions": [
				{
					"id": "bb2e6d15-1b5c-46dd-b0e7-80fb93df4cf0",
					"title": "WITHDRAW Transaction",
					"network": "eip155:11155111",
					"status": "CREATED",
					"type": "WITHDRAW",
					"hash": null,
					"createdAt": "2025-10-27T17:58:19.333Z",
					"broadcastedAt": null,
					"signedTransaction": null,
					"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x02cab2\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x69328dec000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a\",\"nonce\":5,\"type\":2,\"maxFeePerGas\":\"0x0f4252\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
					"stepIndex": 0,
					"gasEstimate": "{\"amount\":\"0.000000365927293316\",\"gasLimit\":\"182962\",\"token\":{\"network\":\"eip155:11155111\",\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"decimals\":18,\"coinGeckoId\":\"ethereum\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\"}}"
				}
			],
			"executionPattern": "synchronous",
			"rawArguments": null,
			"createdAt": "2025-10-27T17:58:19.333Z",
			"completedAt": null,
			"status": "CREATED"
		}
	}
}

Manage yield position

POST https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/manage This endpoint creates an action to manage an existing yield position (claim rewards, compound, etc.). View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`yieldId`*	String	The yield opportunity ID to manage.
`address`*	String	The wallet address that holds the yield position.
`action`*	String	The type of management action (`STAKE`, `UNSTAKE`, `CLAIM_REWARDS`, `RESTAKE_REWARDS`, `WITHDRAW`, `WITHDRAW_ALL`, `RESTAKE`, `CLAIM_UNSTAKED`, `UNLOCK_LOCKED`, `STAKE_LOCKED`, `VOTE`, `REVOKE`, `VOTE_LOCKED`, `REVOTE`, `REBOND`, `MIGRATE`, `VERIFY_WITHDRAW_CREDENTIALS`, `DELEGATE`).
`passthrough`*	String	Passthrough data from the balance’s pending actions.
`arguments`	Object	Optional arguments for the yield management action. View the original Yield.xyz API endpoint for available arguments here

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/manage \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
	"action": "WITHDRAW",
	"address": "0xYourAddress",
	"passthrough": "eyJhZGRyZXNzZXMiOnsiYWRkcmVzcyI6IjB4ZDQwZTg3YmY2...",
	"yieldId": "ethereum-sepolia-link-aave-v3-lending"
}'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"id": "de379c58-0898-45b7-b10a-222fc2f56bd2",
			"intent": "exit",
			"type": "WITHDRAW",
			"yieldId": "ethereum-sepolia-link-aave-v3-lending",
			"address": "0xd40e87bf6d8de3d330fd0284190ba24fd8701f69",
			"amount": "0.001000027202065699",
			"amountRaw": "1000027202065699",
			"amountUsd": null,
			"transactions": [
				{
					"id": "0e471c76-3811-4f22-be81-85bf942334fc",
					"title": "WITHDRAW Transaction",
					"network": "eip155:11155111",
					"status": "CREATED",
					"type": "WITHDRAW",
					"hash": null,
					"createdAt": "2025-10-28T22:43:40.527Z",
					"broadcastedAt": null,
					"signedTransaction": null,
					"unsignedTransaction": "{\"from\":\"0xd40E87bf6d8De3d330fD0284190Ba24FD8701f69\",\"gasLimit\":\"0x02df31\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x69328dec000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe5ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff000000000000000000000000d40e87bf6d8de3d330fd0284190ba24fd8701f69\",\"nonce\":2,\"type\":2,\"maxFeePerGas\":\"0x0f4252\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
					"stepIndex": 0,
					"gasEstimate": "{\"amount\":\"0.000000376421387762\",\"gasLimit\":\"188209\",\"token\":{\"network\":\"eip155:11155111\",\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"decimals\":18,\"coinGeckoId\":\"ethereum\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\"}}"
				}
			],
			"executionPattern": "synchronous",
			"rawArguments": null,
			"createdAt": "2025-10-28T22:43:40.527Z",
			"completedAt": null,
			"status": "CREATED"
		}
	}
}

Submit transaction hash

PUT https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/transactions/:transactionId/submit-hash This endpoint submits a transaction hash after broadcasting a transaction to the network. View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Path Parameters

Name	Type	Description
`transactionId`*	String	The transaction ID to submit the hash for.

Body Parameters

Name	Type	Description
`hash`*	String	The transaction hash from the broadcasted transaction.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the [transactionId] with the actual transaction ID.

curl --request PUT \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/transactions/[transactionId]/submit-hash \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "hash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
}'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"id": "f4186da6-45a1-45ea-9bba-787eb52ab0c8",
			"title": "SUPPLY Transaction",
			"network": "eip155:11155111",
			"status": "BROADCASTED",
			"type": "SUPPLY",
			"hash": "0x13af9685a83e2e77edc6114fb44a12635e9854d71c75b73b0f9a9082dfb1fc3b",
			"createdAt": "2025-10-15T15:56:28.325Z",
			"broadcastedAt": "2025-10-27T18:15:52.120Z",
			"signedTransaction": null,
			"unsignedTransaction": "{\"from\":\"0xEeB97bD9967AB693443F07Fd2CC0B640C72C5696\",\"gasLimit\":\"0x035aee\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x617ba037000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000eeb97bd9967ab693443f07fd2cc0b640c72c56960000000000000000000000000000000000000000000000000000000000000000\",\"nonce\":3,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
			"stepIndex": 1,
			"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000439776397720\",\"gasLimit\":\"219886\"}"
		}
	}
}

Get transaction details

GET https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/transactions/:transactionId This endpoint retrieves details for a specific transaction. View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Path Parameters

Name	Type	Description
`transactionId`*	String	The transaction ID to retrieve details for.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token and the [transactionId] with the actual transaction ID.

curl --request GET \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/transactions/[transactionId] \
  --header 'Authorization: Bearer [token]'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"id": "f4186da6-45a1-45ea-9bba-787eb52ab0c8",
			"title": "SUPPLY Transaction",
			"network": "eip155:11155111",
			"status": "CONFIRMED",
			"type": "SUPPLY",
			"hash": "0x13af9685a83e2e77edc6114fb44a12635e9854d71c75b73b0f9a9082dfb1fc3b",
			"createdAt": "2025-10-15T15:56:28.325Z",
			"broadcastedAt": "2025-10-15T15:57:40.103Z",
			"signedTransaction": null,
			"unsignedTransaction": "{\"from\":\"0xEeB97bD9967AB693443F07Fd2CC0B640C72C5696\",\"gasLimit\":\"0x035aee\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x617ba037000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000eeb97bd9967ab693443f07fd2cc0b640c72c56960000000000000000000000000000000000000000000000000000000000000000\",\"nonce\":3,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
			"stepIndex": 1,
			"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000439776397720\",\"gasLimit\":\"219886\"}"
		}
	}
}

Get historical actions

GET https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions This endpoint retrieves historical yield actions for a client with optional filtering. View the original Yield.xyz API endpoint here.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`offset`	Number	Number of results to skip (for pagination). Defaults to `0`.
`limit`	Number	Maximum number of results to return. Defaults to `100`.
`address`*	String	Filter by wallet address.
`status`	String	Filter by action status (`pending`, `completed`, `failed`).
`intent`	String	Filter by action intent (`enter`, `manage`, `exit`).
`type`	String	Filter by action type (`STAKE`, `UNSTAKE`, `CLAIM_REWARDS`, `RESTAKE_REWARDS`, `WITHDRAW`, `WITHDRAW_ALL`, `RESTAKE`, `CLAIM_UNSTAKED`, `UNLOCK_LOCKED`, `STAKE_LOCKED`, `VOTE`, `REVOKE`, `VOTE_LOCKED`, `REVOTE`, `REBOND`, `MIGRATE`, `VERIFY_WITHDRAW_CREDENTIALS`, `DELEGATE`).
`yieldId`	String	Filter by yield opportunity ID.

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token.

curl --request GET \
  --url 'https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions?address=0xa9a657d08ae6d758378bc9599157d4e6c949073a' \
  --header 'Authorization: Bearer [token]'

Example Response

200: Success
400: Bad Request

{
	"data": {
		"rawResponse": {
			"items": [
				{
					"id": "c402b653-b2d5-40dd-986b-a6b1a051aed6",
					"intent": "enter",
					"type": "STAKE",
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
					"amount": "0.001",
					"amountRaw": "1000000000000000",
					"amountUsd": null,
					"transactions": [
						{
							"id": "24aff0b3-0780-4579-b341-29091f981e57",
							"title": "SUPPLY Transaction",
							"network": "eip155:11155111",
							"status": "CREATED",
							"type": "SUPPLY",
							"hash": null,
							"createdAt": "2025-10-20T14:38:47.849Z",
							"broadcastedAt": null,
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x055730\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x617ba037000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a0000000000000000000000000000000000000000000000000000000000000000\",\"nonce\":0,\"type\":2,\"maxFeePerGas\":\"0x0f4249\",\"maxPriorityFeePerGas\":\"0x0f4237\",\"chainId\":11155111}",
							"stepIndex": 1,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000700000000000\",\"gasLimit\":\"350000\"}"
						},
						{
							"id": "33b13c1c-4dd2-444f-b26a-74168b887231",
							"title": "APPROVAL Transaction",
							"network": "eip155:11155111",
							"status": "CONFIRMED",
							"type": "APPROVAL",
							"hash": "0x6b0cad5912b469ad1e715afe1feff1c8f9c1e2a0d44de72ac712172ef54757ab",
							"createdAt": "2025-10-20T14:38:47.849Z",
							"broadcastedAt": "2025-10-20T14:38:51.438Z",
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0xb629\",\"to\":\"0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5\",\"data\":\"0x095ea7b30000000000000000000000006ae43d3271ff6888e7fc43fd7321a503ff73895100000000000000000000000000000000000000000000000000038d7ea4c68000\",\"nonce\":0,\"type\":2,\"maxFeePerGas\":\"0x0f4249\",\"maxPriorityFeePerGas\":\"0x0f4237\",\"chainId\":11155111}",
							"stepIndex": 0,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000093266000000\",\"gasLimit\":\"46633\"}"
						}
					],
					"executionPattern": "synchronous",
					"rawArguments": null,
					"createdAt": "2025-10-20T14:38:47.849Z",
					"completedAt": null,
					"status": "WAITING_FOR_NEXT"
				},
				{
					"id": "c07547f5-40a6-4ba5-94b7-850b5ae5d1fb",
					"intent": "enter",
					"type": "STAKE",
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
					"amount": "0.001",
					"amountRaw": "1000000000000000",
					"amountUsd": null,
					"transactions": [
						{
							"id": "e5ac7430-8bfe-488b-9c33-8adfbb441466",
							"title": "APPROVAL Transaction",
							"network": "eip155:11155111",
							"status": "SKIPPED",
							"type": "APPROVAL",
							"hash": null,
							"createdAt": "2025-10-20T15:23:14.598Z",
							"broadcastedAt": null,
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x6846\",\"to\":\"0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5\",\"data\":\"0x095ea7b30000000000000000000000006ae43d3271ff6888e7fc43fd7321a503ff73895100000000000000000000000000000000000000000000000000038d7ea4c68000\",\"nonce\":1,\"type\":2,\"maxFeePerGas\":\"0x0f4256\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 0,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000053388587268\",\"gasLimit\":\"26694\"}"
						},
						{
							"id": "129e75d6-8b81-4a84-b76a-6c8e3707ce09",
							"title": "SUPPLY Transaction",
							"network": "eip155:11155111",
							"status": "CONFIRMED",
							"type": "SUPPLY",
							"hash": "0x87b5b910644195a85a6f7eb1ee16329279a9de4c488bc34ce359fe8ad7e506b0",
							"createdAt": "2025-10-20T15:23:14.598Z",
							"broadcastedAt": "2025-10-20T15:23:18.242Z",
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x035aee\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x617ba037000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a0000000000000000000000000000000000000000000000000000000000000000\",\"nonce\":1,\"type\":2,\"maxFeePerGas\":\"0x0f4256\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 1,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000439776837492\",\"gasLimit\":\"219886\"}"
						}
					],
					"executionPattern": "synchronous",
					"rawArguments": null,
					"createdAt": "2025-10-20T15:23:14.598Z",
					"completedAt": "2025-10-20T15:23:27.633Z",
					"status": "SUCCESS"
				},
				{
					"id": "802f1e41-45f7-4f92-a1ba-ae74168f1c20",
					"intent": "enter",
					"type": "STAKE",
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
					"amount": "0.001",
					"amountRaw": "1000000000000000",
					"amountUsd": null,
					"transactions": [
						{
							"id": "6895cb42-1033-4a3c-bb36-b901a8f46d55",
							"title": "SUPPLY Transaction",
							"network": "eip155:11155111",
							"status": "CREATED",
							"type": "SUPPLY",
							"hash": null,
							"createdAt": "2025-10-20T17:54:09.205Z",
							"broadcastedAt": null,
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x055730\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x617ba037000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a0000000000000000000000000000000000000000000000000000000000000000\",\"nonce\":2,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 1,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000700007000000\",\"gasLimit\":\"350000\"}"
						},
						{
							"id": "e86d0011-0ebf-41b4-8f53-8098299c669b",
							"title": "APPROVAL Transaction",
							"network": "eip155:11155111",
							"status": "CONFIRMED",
							"type": "APPROVAL",
							"hash": "0xd31dbd964dbd8cd11be63b3fb4dfc51524b5967d225601b2fadbcd578c9e5f5f",
							"createdAt": "2025-10-20T17:54:09.205Z",
							"broadcastedAt": "2025-10-20T17:54:13.318Z",
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0xb629\",\"to\":\"0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5\",\"data\":\"0x095ea7b30000000000000000000000006ae43d3271ff6888e7fc43fd7321a503ff73895100000000000000000000000000000000000000000000000000038d7ea4c68000\",\"nonce\":2,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 0,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000093266932660\",\"gasLimit\":\"46633\"}"
						}
					],
					"executionPattern": "synchronous",
					"rawArguments": null,
					"createdAt": "2025-10-20T17:54:09.205Z",
					"completedAt": null,
					"status": "WAITING_FOR_NEXT"
				},
				{
					"id": "242bc867-c067-4b17-bda5-368139ed09c8",
					"intent": "enter",
					"type": "STAKE",
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
					"amount": "0.001",
					"amountRaw": "1000000000000000",
					"amountUsd": null,
					"transactions": [
						{
							"id": "c92445e7-8a5b-46c4-9d7c-e6419919492a",
							"title": "APPROVAL Transaction",
							"network": "eip155:11155111",
							"status": "SKIPPED",
							"type": "APPROVAL",
							"hash": null,
							"createdAt": "2025-10-20T17:56:49.997Z",
							"broadcastedAt": null,
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x6846\",\"to\":\"0xf8Fb3713D459D7C1018BD0A49D19b4C44290EBE5\",\"data\":\"0x095ea7b30000000000000000000000006ae43d3271ff6888e7fc43fd7321a503ff73895100000000000000000000000000000000000000000000000000038d7ea4c68000\",\"nonce\":3,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 0,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000053388533880\",\"gasLimit\":\"26694\"}"
						},
						{
							"id": "93159d05-2075-43f5-99fd-35896ad57cfb",
							"title": "SUPPLY Transaction",
							"network": "eip155:11155111",
							"status": "CONFIRMED",
							"type": "SUPPLY",
							"hash": "0xaba10f2a185f47ec31aaf7676cc6d4a00d4454df5789765b9358cdee393fbb42",
							"createdAt": "2025-10-20T17:56:49.997Z",
							"broadcastedAt": "2025-10-20T17:56:54.061Z",
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x02a9a5\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x617ba037000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a0000000000000000000000000000000000000000000000000000000000000000\",\"nonce\":3,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 1,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000349005490020\",\"gasLimit\":\"174501\"}"
						}
					],
					"executionPattern": "synchronous",
					"rawArguments": null,
					"createdAt": "2025-10-20T17:56:49.997Z",
					"completedAt": "2025-10-20T17:57:00.848Z",
					"status": "SUCCESS"
				},
				{
					"id": "397de1ed-9e30-4f7e-8f2c-44f912018936",
					"intent": "exit",
					"type": "UNSTAKE",
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
					"amount": "0.001",
					"amountRaw": "1000000000000000",
					"amountUsd": null,
					"transactions": [
						{
							"id": "48c9bfbb-5798-4c59-8f34-bd6d36f36638",
							"title": "WITHDRAW Transaction",
							"network": "eip155:11155111",
							"status": "CREATED",
							"type": "WITHDRAW",
							"hash": null,
							"createdAt": "2025-10-20T17:59:16.857Z",
							"broadcastedAt": null,
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x02cab2\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x69328dec000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a\",\"nonce\":4,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 0,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000365927659240\",\"gasLimit\":\"182962\"}"
						}
					],
					"executionPattern": "synchronous",
					"rawArguments": null,
					"createdAt": "2025-10-20T17:59:16.857Z",
					"completedAt": null,
					"status": "CREATED"
				},
				{
					"id": "246c1595-3db9-422d-a61e-4c7b3934ebcb",
					"intent": "exit",
					"type": "UNSTAKE",
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
					"amount": "0.001",
					"amountRaw": "1000000000000000",
					"amountUsd": null,
					"transactions": [
						{
							"id": "d9a1a6cd-ff42-456c-aae0-76b62944cdbc",
							"title": "WITHDRAW Transaction",
							"network": "eip155:11155111",
							"status": "CONFIRMED",
							"type": "WITHDRAW",
							"hash": "0x333da3056373c264121353b037d447e9c3c257b405ecc1271a18740819285170",
							"createdAt": "2025-10-20T17:59:50.935Z",
							"broadcastedAt": "2025-10-20T17:59:54.621Z",
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x02cab2\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x69328dec000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a\",\"nonce\":4,\"type\":2,\"maxFeePerGas\":\"0x0f4254\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 0,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000365927659240\",\"gasLimit\":\"182962\"}"
						}
					],
					"executionPattern": "synchronous",
					"rawArguments": null,
					"createdAt": "2025-10-20T17:59:50.935Z",
					"completedAt": "2025-10-20T18:00:03.302Z",
					"status": "SUCCESS"
				},
				{
					"id": "8dfdea4b-dec1-4222-a1b4-fa98bde5f77a",
					"intent": "exit",
					"type": "UNSTAKE",
					"yieldId": "ethereum-sepolia-link-aave-v3-lending",
					"address": "0xa9a657d08ae6d758378bc9599157d4e6c949073a",
					"amount": "0.001",
					"amountRaw": "1000000000000000",
					"amountUsd": null,
					"transactions": [
						{
							"id": "bb2e6d15-1b5c-46dd-b0e7-80fb93df4cf0",
							"title": "WITHDRAW Transaction",
							"network": "eip155:11155111",
							"status": "CREATED",
							"type": "WITHDRAW",
							"hash": null,
							"createdAt": "2025-10-27T17:58:19.333Z",
							"broadcastedAt": null,
							"signedTransaction": null,
							"unsignedTransaction": "{\"from\":\"0xa9a657d08Ae6D758378bC9599157d4e6C949073a\",\"gasLimit\":\"0x02cab2\",\"to\":\"0x6Ae43d3271ff6888e7Fc43Fd7321a503ff738951\",\"data\":\"0x69328dec000000000000000000000000f8fb3713d459d7c1018bd0a49d19b4c44290ebe500000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000000000000a9a657d08ae6d758378bc9599157d4e6c949073a\",\"nonce\":5,\"type\":2,\"maxFeePerGas\":\"0x0f4252\",\"maxPriorityFeePerGas\":\"0x0f4240\",\"chainId\":11155111}",
							"stepIndex": 0,
							"gasEstimate": "{\"token\":{\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"logoURI\":\"https://assets.stakek.it/tokens/eth.svg\",\"network\":\"eip155:11155111\",\"decimals\":18,\"coinGeckoId\":\"ethereum\"},\"amount\":\"0.000000365927293316\",\"gasLimit\":\"182962\"}"
						}
					],
					"executionPattern": "synchronous",
					"rawArguments": null,
					"createdAt": "2025-10-27T17:58:19.333Z",
					"completedAt": null,
					"status": "CREATED"
				}
			],
			"total": 7,
			"offset": 0,
			"limit": 20
		}
	}
}

Deprecated Endpoints:

Get the client’s NFTs by chain (@deprecated)

GET https://api.portalhq.io/api/v3/clients/me/nfts This endpoint retrieves the NFTs for the client for a particular chain.

Supported Chains

Ethereum Mainnet (eip155:1)
Ethereum Goerli (eip155:5) // @deprecated
Ethereum 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:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`chainId`*	String	Must be in CAIP-2 format (e.g. `"eip155:10143"`).

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

[
  {
    "contract": {
      "address": "0xabcdef1234567890abcdef1234567890abcdef12"
    },
    "id": {
      "tokenId": "99",
      "tokenMetadata": {
        "tokenType": "ERC721"
      }
    },
    "title": "GalacticExplorer #99",
    "description": "Galactic Explorers venture into the unknown regions of space to discover new worlds and civilizations.",
    "tokenUri": {
      "raw": "https://galacticexplorers.io/api/explorers/99",
      "gateway": "https://galacticexplorers.io/api/explorers/99"
    },
    "media": [
      {
        "raw": "https://galacticexplorers.io/explorer_images/99.png",
        "gateway": "https://galacticexplorers.io/explorer_images/99.png"
      }
    ],
    "metadata": {
      "name": "GalacticExplorer #99",
      "description": "Galactic Explorers venture into the unknown regions of space to discover new worlds and civilizations.",
      "image": "https://galacticexplorers.io/explorer_images/99.png",
      "external_url": "https://galacticexplorers.io",
      "attributes": [
        {
          "value": "Space Suit (Blue)",
          "trait_type": "Clothes"
        },
        {
          "value": "Happy Smile",
          "trait_type": "Mouth"
        },
        {
          "value": "Space",
          "trait_type": "Background"
        }
      ]
    },
    "timeLastUpdated": "2023-01-01T10:00:00.000Z",
    "contractMetadata": {
      "name": "GalacticExplorers",
      "symbol": "GEXP",
      "totalSupply": "5000",
      "tokenType": "ERC721"
    }
  },
  ...
]

Simulate a transaction (@deprecated)

POST https://api.portalhq.io/api/v3/clients/me/simulate-transaction Simulates a transaction for a specific chain.

Supported Chains

Ethereum Mainnet (eip155:1)
Ethereum Goerli (eip155:5) // @deprecated
Ethereum 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:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`chainId`*	String	Must be in CAIP-2 format (e.g. `"eip155:10143"`).

Body Parameters

Name	Type	Description
`from`*	String	The sender’s address.
`to`*	String	The recipient’s address.
`gas`	String	The gas limit provided for the transaction.
`gasPrice`	String	The price per unit of gas the sender is willing to pay.
`maxFeePerGas`	String	The maximum total fee per gas unit the sender is willing to pay.
`maxPriorityFeePerGas`	String	The maximum priority fee per gas unit the sender is willing to pay.
`value`	String	The amount of native token to send with the transaction.
`data`	String	The input data to send with the transaction (used for contract calls).
`nonce`	String	The transaction count of the sender’s address, used to ensure uniqueness.

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "changes": [
    {
      "amount": "0.000000000000000016",
      "assetType": "NATIVE",
      "changeType": "TRANSFER",
      "contractAddress": null,
      "decimals": 18,
      "from": "0x0282c3974e48e645d977758838a0211e5c11bd64",
      "name": "Ethereum",
      "rawAmount": "16",
      "symbol": "ETH",
      "to": "0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad",
      "tokenId": null
    }
  ],
  "gasUsed": "0x5258"
}

Get the client’s ERC20 assets by chain (@deprecated)

GET https://api.portalhq.io/api/v3/clients/me/balances Retrieves the client’s ERC20 balances for a specific chain.

Supported Chains

Ethereum Mainnet (eip155:1)
Ethereum Goerli (eip155:5) // @deprecated
Ethereum 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:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Query Parameters

Name	Type	Description
`chainId`*	String	Must be in CAIP-2 format (e.g. `"eip155:10143"`).

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

[
  {
    "contractAddress": "0x1f9840a85d5af5bf1d1762f925bdaddc4201f984",
    "balance": "0.000211681761928783"
  }
]

Get swap quote (@deprecated)

POST https://api.portalhq.io/api/v3/swaps/quote This endpoint retrieves a swap quote for trading tokens on a specific chain.

This endpoint is deprecated. Use the new swap endpoints under the Swaps section instead.

Supported Chains

Ethereum (eip155:1)
Monad Testnet (eip155:10143)
Base (eip155:8453)
Arbitrum (eip155:42161)
Optimism (eip155:10)
Avalanche (eip155:43114)
Polygon (eip155:137)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`address`*	String	The client’s address.
`apiKey`*	String	Your 0x API key for swap functionality.
`chainId`*	String	Must be in CAIP-2 format (e.g. `"eip155:10143"`).
`buyToken`*	String	The token symbol you want to buy (e.g., “ETH”, “USDC”, “0x123abc”).
`sellToken`*	String	The token symbol you want to sell (e.g., “ETH”, “USDC”, “0x123abc”).
`sellAmount`*	String	The amount to sell (in wei for ETH, or smallest unit for tokens).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token, the address with the client’s address, the apiKey with your 0x API key, and the chainId with a valid chain value.

curl --request POST \
  --url https://api.portalhq.io/api/v3/swaps/quote \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "0xb5502c8f8ee051d5937f32b774fb087e4a2fd78d",
  "apiKey": "your-0x-api-key",
  "chainId": "eip155:1",
  "buyToken": "USDC",
  "sellToken": "ETH",
  "sellAmount": "1000000000000000000"
}'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "allowanceTarget": "",
  "cost": 0.000606576879480788,
  "transaction": {
    "to": "0x0000000000001ff3684f28c67538d4d072c22734",
    "data": "0x2213bc0b...",
    "gas": "0x67f54",
    "gasPrice": "0x54e86ba1",
    "value": "0xde0b6b3a7640000",
    "from": "0xb5502c8f8ee051d5937f32b774fb087e4a2fd78d"
  }
}

Get swap sources (@deprecated)

POST https://api.portalhq.io/api/v3/swaps/sources This endpoint retrieves the available swap sources for a specific chain.

This endpoint is deprecated. Use the new swap endpoints under the Swaps section instead.

Supported Chains

Ethereum (eip155:1)
Monad Testnet (eip155:10143)
Base (eip155:8453)
Arbitrum (eip155:42161)
Optimism (eip155:10)
Avalanche (eip155:43114)
Polygon (eip155:137)

When using CAIP-2 chain formats in the URL (e.g. eip155:10143), ensure the URL is URI encoded to accommodate the ”:” character.

Headers

Name	Type	Description
Authorization*	String	Bearer `<Client API Key>`
Content-Type*	String	application/json

Body Parameters

Name	Type	Description
`apiKey`*	String	Your 0x API key for swap functionality.
`chainId`*	String	Must be in CAIP-2 format (e.g. `"eip155:10143"`).

Example Request

Be sure to replace the [token] with either a Client API Key or a Client Session Token, the apiKey with your 0x API key, and the chainId with a valid chain value.

curl --request POST \
  --url https://api.portalhq.io/api/v3/swaps/sources \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
  "apiKey": "your-0x-api-key",
  "chainId": "eip155:1"
}'

Example Response

200: Success
400: Bad Request
401: Unauthorized Request

{
  "0x_RFQ": "0x_RFQ",
  "Ambient": "Ambient",
  "Angle": "Angle",
  "Balancer_V1": "Balancer_V1",
  "Balancer_V2": "Balancer_V2",
  "Balancer_V3": "Balancer_V3",
  "Bancor_V3": "Bancor_V3",
  "Curve": "Curve",
  "DODO_V1": "DODO_V1",
  "DODO_V2": "DODO_V2",
  "DeFi_Swap": "DeFi_Swap",
  "Ekubo": "Ekubo",
  "Fluid": "Fluid",
  "Fraxswap_V2": "Fraxswap_V2",
  "Integral": "Integral",
  "Lido": "Lido",
  "Maker_PSM": "Maker_PSM",
  "Maverick": "Maverick",
  "Maverick_V2": "Maverick_V2",
  "Origin": "Origin",
  "PancakeSwap_V2": "PancakeSwap_V2",
  "PancakeSwap_V3": "PancakeSwap_V3",
  "Polygon_Migration": "Polygon_Migration",
  "RingSwap": "RingSwap",
  "RocketPool": "RocketPool",
  "ShibaSwap": "ShibaSwap",
  "Sky_Migration": "Sky_Migration",
  "Solidly_V3": "Solidly_V3",
  "Spark": "Spark",
  "Stepn": "Stepn",
  "SushiSwap": "SushiSwap",
  "SushiSwap_V3": "SushiSwap_V3",
  "Swaap_V2": "Swaap_V2",
  "Synapse": "Synapse",
  "Uniswap_V2": "Uniswap_V2",
  "Uniswap_V3": "Uniswap_V3",
  "Uniswap_V4": "Uniswap_V4",
  "Yearn": "Yearn",
  "Yearn_V3": "Yearn_V3"
}

Getting Started

SDKs

APIs

Integrations

Resources

​Sections

​Clients

​Get the client’s details

Headers

Example Request

Example Response

​Get the client’s assets by chain

Supported Chains

Headers

Query Parameters

Example Request

Example Response

​Get the client’s assets by chain (NFTs only)

Supported Chains

Headers

Query Parameters

Example Request

Example Response

​Get the client’s Solana transaction history

Supported Chains

Headers

Path Parameters

Query Parameters

Example Request

Example Response

​Get the client’s EIP-155 transaction history

Supported Chains

Headers

Query Parameters

Example Request

Example Response

​Fund wallet with testnet tokens

Supported Chains

Headers

Body Parameters

Example Request

Example Response

​Build a transaction

Supported Chains

Headers

Path Parameters

Body Parameters

Example Request

Example Response

Notes

​Simulate + validate a transaction

Supported Chains

Headers

Query Parameters

Body Parameters

Example Request

Example Response

​Client Shares

​Update the client’s signing share pairs’ statuses

Headers

Body Parameters

Example Request

Example Response

​Update the client’s backup share pairs’ statuses

Headers

Body Parameters

Example Request

Example Response

​Store the client’s encrypted backup share for Portal-Managed Backups

Headers

Body Parameters

Example Request

Example Response

​Get the encrypted client backup share for Portal-Managed Backups

Headers

Example Request

Example Response

​Get the ejectable backup shares for Portal-Managed Backups

Headers

Example Request

Sections

Clients

Get the client’s details

Get the client’s assets by chain

Get the client’s assets by chain (NFTs only)

Get the client’s Solana transaction history

Get the client’s EIP-155 transaction history

Fund wallet with testnet tokens

Build a transaction

Simulate + validate a transaction

Client Shares

Update the client’s signing share pairs’ statuses

Update the client’s backup share pairs’ statuses

Store the client’s encrypted backup share for Portal-Managed Backups

Get the encrypted client backup share for Portal-Managed Backups

Get the ejectable backup shares for Portal-Managed Backups

Swaps

Get available swap sources

Get swap quote

Get swap price

Yield.xyz Integration

Get yield opportunities

Get yield balances

Enter yield position

Exit yield position

Manage yield position

Submit transaction hash

Get transaction details

Get historical actions

Deprecated Endpoints:

Get the client’s NFTs by chain (@deprecated)