Before going live with real users, always ensure that you create clients using a Portal API Key from your Portal’s Production environment. Read more here on going live with real users.

​
Clients

​
Create a new client

POST https://api.portalhq.io/api/v3/custodians/me/clients Registers a new client and returns a client API key, client session token, and whether they are AA enabled.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Body Parameters
NameTypeDescription
isAccountAbstractedBoolean (optional)The client will use ERC-4337 Account Abstraction (AA).
Example Request
Be sure to replace the [token] with a Custodian API Key. 
curl --request POST \
  --url https://api.portalhq.io/api/v3/custodians/me/clients \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
	"isAccountAbstracted": false
}
'
Example Response
{
  "id": "string",
  "clientApiKey": "string",
  "clientSessionToken": "string",
  "isAccountAbstracted": boolean
}

​
Create a Client Session Token (CST) for a client

POST https://api.portalhq.io/api/v3/custodians/me/clients/[clientId]/sessions Creates a new Client Session Token for a client.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Path Parameters
NameTypeDescription
clientIdd;”>*StringThe ID of a client.
Example Request
Be sure to replace the [token] with a Custodian API Key and the [clientId] with the relevant Portal client ID. 
curl --request POST \
  --url https://api.portalhq.io/api/v3/custodians/me/clients/[clientId]/sessions \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
	"isAccountAbstracted": false
}
'
Example Response
{
  "id": "string",
  "clientSessionToken": "string",
  "isAccountAbstracted": boolean
}

​
Create a one-time password (OTP) for a client using the Web SDK

POST https://api.portalhq.io/api/v1/custodians/clients/[clientId]/web-otp Generate a one-time password for a client.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Path Parameters
NameTypeDescription
clientIdd;”>*StringThe ID of a client.
Example Request
Be sure to replace the [token] with a Custodian API Key and the [clientId] with the relevant Portal client ID. 
curl --request POST \
  --url https://api.portalhq.io/api/v1/custodians/clients/[clientId]/web-otp \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json'
'
Example Response
{
  "id": "string"
  "otp": "string"
}

​
Get a single client

GET https://api.portalhq.io/api/v3/custodians/me/clients/[clientId] Fetches the specified client for the authorized custodian.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Path Parameters
NameTypeDescription
clientIdd;”>*StringThe ID of the client.
Example Request
Be sure to replace the [token] with a Custodian API Key and the [clientId] with the relevant Portal client ID. 
curl --request GET \
  --url https://api.portalhq.io/api/v3/custodians/me/clients/[clientId] \
  --header 'Authorization: Bearer [token]'
'
Example Response
{
  "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": {
      "eip155": {
        "address": "0x6e818d8f9b6c53c59a2d957d36c2146e28906195",
        "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 a list of clients

GET https://api.portalhq.io/api/v3/custodians/me/clients Fetches all clients for the authorized custodian.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Query Parameters
NameTypeDescription
cursorStringThe ID of the last client in the list. Used for cursor-based pagination.
takeNumberThe number of records to retrieve. Maximum is 100. Default is 100.
Example Request
Be sure to replace the [token] with a Custodian API Key. 
curl --request GET \
  --url https://api.portalhq.io/api/v3/custodians/me/clients \
  --header 'Authorization: Bearer [token]'
'
Example Response
{
  "results": [
    {
      "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": {
          "eip155": {
            "address": "0x6e818d8f9b6c53c59a2d957d36c2146e28906195",
            "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"
        }
      ]
    },
    ...
  ],
  "metadata": {
    "cursor": "nextCursorToUse",
    "take": 100,
    "total": 1000
  }
}

​
Get a list of assets for a client

GET https://api.portalhq.io/api/v3/custodians/me/clients/:clientId/chains/:chain/assets This endpoint retrieves the asset balances (native and token balances) for a specified client and 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.
  • 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)
  • 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)
  • Avalanche Mainnet (eip155:43114)
  • Linea Mainnet (eip155:59144)
  • Celo (eip155:42220)
  • Celo Alfajores Testnet (eip155:44787)
When using CAIP-2 chain formats in the URL (e.g. eip155:11155111), ensure the URL is URI encoded to accommodate the ”:” character.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Path Parameters
NameTypeDescription
clientIdd;”>*StringThe ID of the client.
chainIdd;”>*StringMust be in CAIP-2 format or chain identifier shortcut (e.g. eip155:11155111 or sepolia).
Example Request
Be sure to replace the [token] with a Custodian API Key, the chain with a valid chain value, and the clientId with the relevant Portal client ID. 
curl --request GET \
  --url https://api.portalhq.io/api/v3/custodians/me/clients/[clientId]/chains/[chain]/assets \
  --header 'Authorization: Bearer [token]'
'
Example Response
{
  "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"
        }
      }
    }
  ]
}

​
Build transaction for a client

POST https://api.portalhq.io/api/v3/custodians/me/clients/:clientId/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):
    • ethereum (eip155:1)
    • sepolia (eip155:11155111)
    • base (eip155:8453)
    • base-sepolia (eip155:84531)
    • 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:11155111), ensure the URL is URI encoded to accommodate the ”:” character.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Path Parameters
NameTypeDescription
clientIdd;”>*StringThe ID of the client.
chaind;”>*StringMust be one of the chains in “Supported Chains”.
Body Parameters
NameTypeDescription
tod;”>*StringThe recipient’s address.
tokend;”>*StringThe token symbol (e.g., “USDC”) or contract address or mint address (for Solana).
amountd;”>*StringThe 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 a Custodian API Key, the chain with a valid chain value, and the clientId with the relevant Portal client ID. 
curl --request POST \
  --url https://api.portalhq.io/api/v3/custodians/me/clients/[clientId]/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). 
{
  "transaction": {
    "from": "0x21d8d1d2d9907c051670d8c9a80bd2192d273f8d",
    "to": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "data": "0xa9059cbb000000000000000000000000dfd8302f44727a6348f702ff7b594f127de3a9020000000000000000000000000000000000000000000000000000000000002710"
  },
  "metadata": {
    "rawAmount": "10000",
    "formattedAmount": "0.01",
    "tokenDecimals": 6,
    "tokenAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
  }
}
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.

​
Client Shares

​
Prepare a client for eject

PATCH https://api.portalhq.io/api/v3/custodians/me/clients/[clientId]/enable-eject Your custodian must be using Portal-Managed Backups to use this endpoint. Prepare a wallet for ejection of its private keys. This endpoint will enable a Portal client to be ejected for 5 minutes. You can find the walletId parameter from the Get a Single Client endpoint.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Body Parameters
NameTypeDescription
ejectableUntilString (ISO format)The time the wallet will no longer be ejectable. Must be a date at least 1 minute from now.
walletIdd;”>*StringThe walletId of the wallet to eject.
Example Request
Be sure to replace the [token] with a Custodian API Key and the [clientId] with the relevant Portal client ID. 
curl --request PATCH \
  --url https://api.portalhq.io/api/v3/custodians/me/clients/[clientId]/enable-eject \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
      "ejectableUntil": "2025-06-18T15:23:00.470Z",
      "walletId": "walletId"
}
'
Example Response
{
  "ejectableUntil": "2025-03-04T15:26:43.123Z"
}

​
Get a client’s backup shares

GET https://api.portalhq.io/api/v3/custodians/me/clients/:clientId/wallets/:walletId/ejectable-backup-shares Your custodian must be using Portal-Managed Backups to use this endpoint. Fetches a client’s encrypted backup share (if you sent it to Portal previously) 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
NameTypeDescription
Authorization*StringBearer <Client API Key>
Content-Type*Stringapplication/json
Example Request
Be sure to replace the [token] with a Custodian API Key, the [walletId] with the Portal client’s wallet ID, and the [clientId] with the relevant Portal client ID. 
curl --request GET \
  --url https://api.portalhq.io/api/v3/custodians/me/clients/[clientId]/wallets/[walletId]/ejectable-backup-shares \
  --header 'Authorization: Bearer [token]'
'
Example Response
{
  "encryptedClientBackupShare": "0351cf2baa54748662a6c89bb032...", // Or null
  "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\"}"
}

​
Alert Webhooks

​
Get a list of alert webhooks

GET https://api.portalhq.io/api/v3/custodians/me/alerts/webhooks Retrieve a list of your alert webhooks configured in your Portal Admin Dashboard.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Example Request
Be sure to replace the [token] with a Custodian API Key. 
curl --request GET \
  --url 'https://api.portalhq.io/api/v3/custodians/me/alerts/webhooks' \
  --header 'Authorization: Bearer [token]'
Example Response
{
  "data": [
    {
      "autoAddNewAddresses": true,
      "createdAt": "2024-12-19T19:05:04.707Z",
      "events": ["EIP_155_TX_V1"],
      "id": "cm4voycw2001f68veade3tr0i",
      "updatedAt": "2024-12-19T20:07:16.648Z",
      "url": "https://example.com/alerts-webhooks/1/events"
    }
  ]
}

​
Get a list of events sent to your alert webhook

GET https://api.portalhq.io/api/v3/custodians/me/alerts/webhooks/:alertWebhookId/events Retrieve a list of the events sent to your alert webhook (including those that failed to be delivered).
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Query Parameters
NameTypeDescription
eventTypesd;”>*“EIP_155_TX_V1”The alert webhook event types.
deliveryStatuses”success”, “failed”, “pending”Returns only alert webhook events with one of the specified delivery statuses.
sinceUnix NumberReturns only alert webhook events that occurred after this time.
untilUnix NumberReturns only alert webhook events that occurred before this time.
cursorStringThe alert webhook event “id” for cursor-based pagination.
limitNumber (default: 100)The amount of alert webhook events to get back in the request.
transactionHashStringReturns only alert webhook events that include this transaction hash.
blockNumbersString (multiple delimited by ”,“)Returns only alert webhook events that include these block numbers.
chainIdsCAIP-2 chains (multiple delimited by ”,“)Returns only alert webhook events that include these chainIds.
Example Request
Be sure to replace the [token] with a Custodian API Key and the [webhookId] with the alert webhook ID you are interested in. 
curl --request GET \
  --url 'https://api.portalhq.io/api/v3/custodians/me/alerts/webhooks/[webhookId]/events' \
  --header 'Authorization: Bearer [token]'
Example Response
{
  "data": [
    // Successfully delivered alert webhook event retry.
    {
      "blockNumber": 7313326,
      "chainId": "eip155:11155111",
      "confirmed": 1,
      "createdAt": "2024-12-19T20:08:17.086Z",
      "deliveryStatus": "success",
      "errorMessage": null,
      "id": "85f3d2f7-b2ff-417d-b9cb-dc9823b4ae61",
      "retries": 0,
      "transactionHashes": [
        "0x4978a4ba15a018532791ba4491e48b1aa8b544309c1ffce062bb1fb7e84dc069"
      ],
      "type": "EIP_155_TX_V1",
      "updatedAt": "2024-12-19T20:08:17.086Z"
    },
    // Failed to deliver alert webhook event retry.
    {
      "blockNumber": 7313326,
      "chainId": "eip155:11155111",
      "confirmed": null,
      "createdAt": "2024-12-19T20:06:50.272Z",
      "deliveryStatus": "failed",
      "errorMessage": "Request failed with status code 400",
      "id": "f928772e-add0-4bf9-b0d3-c45f94513929",
      "retries": 1,
      "transactionHashes": [
        "0x4978a4ba15a018532791ba4491e48b1aa8b544309c1ffce062bb1fb7e84dc069"
      ],
      "type": "EIP_155_TX_V1",
      "updatedAt": "2024-12-19T20:06:50.272Z"
    },
    // Failed to deliver alert webhook event.
    {
      "blockNumber": 7313326,
      "chainId": "eip155:11155111",
      "confirmed": null,
      "createdAt": "2024-12-19T20:05:42.679Z",
      "deliveryStatus": "failed",
      "errorMessage": "Request failed with status code 400",
      "id": "eb7c6438-dc76-4d26-a704-1621f66b2972",
      "retries": 0,
      "transactionHashes": [
        "0x4978a4ba15a018532791ba4491e48b1aa8b544309c1ffce062bb1fb7e84dc069"
      ],
      "type": "EIP_155_TX_V1",
      "updatedAt": "2024-12-19T20:05:42.679Z"
    },
    // Successfully delivered alert webhook event.
    {
      "blockNumber": 7313246,
      "chainId": "eip155:11155111",
      "confirmed": 1,
      "createdAt": "2024-12-19T19:50:51.760Z",
      "deliveryStatus": "success",
      "errorMessage": null,
      "id": "f8600f2b-3970-4a1d-a4cb-00795c5879f6",
      "retries": 0,
      "transactionHashes": [
        "0xbed0c8f1c3eca9ff6b5c26c6b79f996e2be147dfe7e981bac4853eb13044112c"
      ],
      "type": "EIP_155_TX_V1",
      "updatedAt": "2024-12-19T19:50:51.760Z"
    },
  ],
  "metadata": {
    "alertWebhook": {
      "id": "alertWebhookId1",
      "url": "https://example.com/alerts/webhooks/1/events"
    },
    "cursor": null, // The alert webhook event "id".
    "limit": 100,
    "total": 4
  }
}

​
Replay failed-to-deliver alert webhook events

POST https://api.portalhq.io/api/v3/custodians/me/alerts/webhooks/:alertWebhookId/events/failed/replay Replays a list of alert webhook events with a delivery status of "failed".
If the "failed" alert webhook event has already been replayed successfully, you cannot replay the alert webhook event again with this endpoint.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Path Parameters
NameTypeDescription
alertWebhookIdd;”>*StringThe “id” of the alert webhook. You can get this from the list alert webhooks endpoint.
Body Parameters
NameTypeDescription
eventIdsd;”>*String[]A list of “failed” alert webhook event “id”s to replay.
Example Request
Be sure to replace the [token] with a Custodian API Key and the [webhookId] with the alert webhook ID you are interested in. 
curl --request POST \
  --url https://api.portalhq.io/api/v3/custodians/me/alerts/webhooks/[webhookId]/events/failed/replay \
  --header 'Authorization: Bearer [token]' \
  --header 'Content-Type: application/json' \
  --data '{
	"eventIds": ["eventId1"]
}'
Example Response
{
  "data": {
    "replaying": ["alertWebhookEventId1"], // The alert webhook events are currently being replayed.
    "failed": ["alertWebhookEventId2"] // The alert webhook events failed to be replayed.
  }
}

​
Gas Sponsorship:

​
Get historical gas sponsorship usage by chain

GET https://api.portalhq.io/api/v3/custodians/me/gas-sponsors/chains/:chainId/usage Retrieves historical gas sponsorship usage by chain for your Portal environment.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Path Parameters
NameTypeDescription
chainIdd;”>*CAIP-2 chainThe CAIP-2 chain ID. Be sure it is URL encoded.
Example Request
Be sure to replace the [token] with a Custodian API Key. 
curl --request GET \
  --url https://api.portalhq.io/api/v3/custodians/me/gas-sponsors/chains/solana%3AEtWTRABZaYq6iMfeYKouRu166VU2xqa1/usage \
  --header 'Authorization: Bearer [token]'
Example Response
{
  "address": "75ZfLXXsSpycDvHTQuHnGQuYgd2ihb6Bu4viiCCQ7P4H", // Your gas sponsor's address
  "chainId": "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1",
  "usageData": [
    {
      "month": "June",
      "year": 2025,
      "usage": "0.011249279999999794",
      "txCount": 921
    },
    {
      "month": "May",
      "year": 2025,
      "usage": "0.01",
      "txCount": 2
    }
  ],
  "totalUsage": "0.021249279999999794",
  "totalTxsSponsored": 923
}

​
Deprecated Endpoints:

​
Format a raw alert webhook event (@deprecated)

POST https://api.portalhq.io/api/v3/custodians/me/alerts/wallets/format This endpoint formats a raw webhook request body for wallet events.
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)
  • Solana Mainnet (solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp or solana)
  • Solana Devnet (solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1 or solana-devnet)
  • Base Mainnet (eip155:8453 or base)
  • Base Sepolia (eip155:84531 or base-sepolia)
  • Polygon Mainnet (eip155:137 or polygon)
  • Polygon Mumbai (eip155:80001 or polygon-mumbai)
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Body Parameters
NameTypeDescription
chaind;”>*"eip155"The chain the raw webhook event is from.
rawAlertd;”>*StringThe stringified raw webhook event.
Example Response
{
  chainName: 'sepolia',
  chainId: 'eip155:11155111',
  from: '0xf428e1f82f18de15ef2861a4bdde42e755998ece',
  to: '0xdfd8302f44727a6348f702ff7b594f127de3a902',
  amount: '0.001',
  tokenSymbol: 'USDC',
  assetType: 'NON_NATIVE_TOKEN',
  direction: 'OUTBOUND',
  metadata: {
    confirmed: true,
    rawAmount: '1000',
    tokenDecimals: '6',
    tokenAddress: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238',
    tokenName: 'USDC',
    sentAt: '2024-09-06T20:30:24.000Z',
    transactionHash: '0x229c1cc8ed898fae917e0ed90af94c624015e53a790eda1a7d30b1ca2ffd916c',
    blockNumber: '6645168',
    fee: {
      amount: '0.000172838817388923',
      decimals: 18,
      rawAmount: '172838817388923',
      tokenSymbol: 'ETH'
    },
    nftTokenId: null,
    triggeredBy: '0xf428e1f82f18de15ef2861a4bdde42e755998ece',
    userOperationHash: '0x82b24bc1feb022bcf621d22efd473acf7bdb6fdd108c7bbaaf988a1717edfdb4'
  }
}

​
Format raw alert webhook events (@deprecated)

POST https://api.portalhq.io/api/v3/custodians/me/alerts/format This endpoint formats a raw webhook request body for wallet events, which may include one or many transactions at once.
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)
  • Solana Mainnet (solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp or solana)
  • Solana Devnet (solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1 or solana-devnet)
  • Base Mainnet (eip155:8453 or base)
  • Base Sepolia (eip155:84531 or base-sepolia)
  • Polygon Mainnet (eip155:137 or polygon)
  • Polygon Mumbai (eip155:80001 or polygon-mumbai)
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Body Parameters
NameTypeDescription
chaind;”>*"eip155"The chain the raw webhook event is from.
rawAlertd;”>*StringThe stringified raw webhook event.
Example Response
[
  {
    chainName: 'sepolia',
    chainId: 'eip155:11155111',
    from: '0xf428e1f82f18de15ef2861a4bdde42e755998ece',
    to: '0xdfd8302f44727a6348f702ff7b594f127de3a902',
    amount: '0.001',
    tokenSymbol: 'USDC',
    assetType: 'NON_NATIVE_TOKEN',
    direction: 'OUTBOUND',
    metadata: {
      confirmed: true,
      rawAmount: '1000',
      tokenDecimals: '6',
      tokenAddress: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238',
      tokenName: 'USDC',
      sentAt: '2024-09-06T20:30:24.000Z',
      transactionHash: '0x229c1cc8ed898fae917e0ed90af94c624015e53a790eda1a7d30b1ca2ffd916c',
      blockNumber: '6645168',
      fee: {
        amount: '0.000172838817388923',
        decimals: 18,
        rawAmount: '172838817388923',
        tokenSymbol: 'ETH'
      },
      nftTokenId: null,
      triggeredBy: '0xf428e1f82f18de15ef2861a4bdde42e755998ece',
      userOperationHash: '0x82b24bc1feb022bcf621d22efd473acf7bdb6fdd108c7bbaaf988a1717edfdb4'
    }
  }
]

​
Replay an alert webhook event by block number (@deprecated)

POST https://api.portalhq.io/api/v3/custodians/me/alerts/retry-by-block-number This endpoint attempts to resend a wallet event scoped by a block number in the scenario you need to replay a transaction.
Supported Chains
EVM chains.
Headers
NameTypeDescription
Authorization*StringBearer <Custodian API Key>
Content-Type*Stringapplication/json
Body Parameters
NameTypeDescription
chainReferenceIdd;”>*StringThe EVM chain reference ID. (e.g. "11155111" for Sepolia)
blockNumberd;”>*NumberThe block number of the transaction(s) you want to resend.
streamIdd;”>*StringThe ID of the stream that Portal configured for you. (Reach out to our team to get this.)
Example Response
No content