AppController_getBridgingStatus

GET 
/v2/bridge-status

AppController_getBridgingStatus

Request

Query Parameters

transactionHash stringrequired
Transaction hash originating from the source chain while bridging assets.
Example: 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
fromChainId stringrequired
ID of source chain, e.g Ethereum Mainnet = 1
Example: 1
toChainId string
ID of destination chain, e.g Ethereum Mainnet = 1
Example: 137
bridgeName string
Name of the bridge used while bridging.
Example: hop
isBridgeProtectionTx boolean
Is the transaction a bridge protection transaction.
Example: false

Header Parameters

API-KEY string

Responses

200

Returns the status of the bridging transaction if completed or pending.

application/json

Schema

Schema

successbooleanrequired
Status of API.
Example: true

result

object

required

sourceTransactionHashstringrequired

Source Transaction.

Example: 0xa6574b28b36dceb147a7ff3ca06839f1f0835bcfd5f0409406fbc524412e281a

sourceTxStatusstringrequired

Status of source transaction while bridging.

Possible values: [PENDING, COMPLETED]

Example: COMPLETED

destinationTransactionHashstring

Destination Transaction hash.

Example: 0xa6574b28b36dceb147a7ff3ca06839f1f0835bcfd5f0409406fbc524412e281a

destinationTxStatusstringrequired

Status of destination transaction while bridging.

Possible values: [PENDING, COMPLETED]

Example: COMPLETED

fromChainIdnumberrequired

Source Chain Id

Example: 1

toChainIdnumberrequired

Destination Chain Id.

Example: 137

fromAsset

object

required

namestring

Name of token.

Example: USD Coin

addressstringrequired

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstringrequired

Symbol of token.

Example: USDC

chainIdstringrequired

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

toAsset

object

required

namestring

Name of token.

Example: USD Coin

addressstringrequired

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstringrequired

Symbol of token.

Example: USDC

chainIdstringrequired

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

srcTokenPricestringrequired

Price of the input token

destTokenPricestringrequired

Price of the outputToken token

fromAmountstringrequired

Price of the outputToken token

toAmountstringrequired

Price of the outputToken token

senderstringrequired

address of the sender

recipientstringrequired

address of the recipient

isSocketTxbooleanrequired

identifies if its a socket tx or not.

bridgeNamestringrequired

Name of the bridge used

refuel

object

nullable

required

destinationTxStatusstringrequired

sourceTxStatusstringrequired

bridgestringrequired

statusstringrequired

destinationTransactionHashstringrequired

recipientstringrequired

senderstringrequired

isSocketTxbooleanrequired

fromAmountstringrequired

toAmountstringrequired

fromTokenAddressstringrequired

toTokenAddressstringrequired

isMultiBridgebooleanrequired

destinationChainIdnumberrequired

Example (from schema)

{
  "success": true,
  "result": {
    "sourceTransactionHash": "0xa6574b28b36dceb147a7ff3ca06839f1f0835bcfd5f0409406fbc524412e281a",
    "sourceTxStatus": "COMPLETED",
    "destinationTransactionHash": "0xa6574b28b36dceb147a7ff3ca06839f1f0835bcfd5f0409406fbc524412e281a",
    "destinationTxStatus": "COMPLETED",
    "fromChainId": 1,
    "toChainId": 137,
    "fromAsset": {
      "name": "USD Coin",
      "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
      "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "decimals": 6,
      "symbol": "USDC",
      "chainId": 137,
      "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "chainAgnosticId": "DAI"
    },
    "toAsset": {
      "name": "USD Coin",
      "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
      "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "decimals": 6,
      "symbol": "USDC",
      "chainId": 137,
      "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "chainAgnosticId": "DAI"
    },
    "srcTokenPrice": "string",
    "destTokenPrice": "string",
    "fromAmount": "string",
    "toAmount": "string",
    "sender": "string",
    "recipient": "string",
    "isSocketTx": true,
    "bridgeName": "string",
    "refuel": {
      "destinationTxStatus": "string",
      "sourceTxStatus": "string",
      "bridge": "string",
      "status": "string",
      "destinationTransactionHash": "string",
      "recipient": "string",
      "sender": "string",
      "isSocketTx": true,
      "fromAmount": "string",
      "toAmount": "string",
      "fromTokenAddress": "string",
      "toTokenAddress": "string",
      "isMultiBridge": true,
      "destinationChainId": 0
    }
  }
}