Bridge Status
Returns the status of cross-chain bridging transaction using Socket
/v2/bridge-status
How this API is used in Socket :
- The bridge status API is used to track whether a cross-chain bridging transaction has completed or not. All the statuses returned by /bridge-status can be found here.
- In case of bridges such as Polygon Native Bridge where a claiming/exit transaction is required on the destination chain to claim tokens, the bridge status API can be used to alert a user when claiming is available
API-KEY needs to be passed in the headers while making the
GET
requestget
https://api.socket.tech/v2
/bridge-status
Returns the status of cross-chain transaction
NOTE :
For Polygon Native Bridge and Arbitrum Native Bridge, the bridgeName
paramater is required to be filled in. For the others, it is optional.Parameter | Description |
---|---|
success | Indicates successful response from endpoint, as intended. |
sourceTransactionHash | Hash of source transaction |
sourceTxStatus | |
destinationTransactionHash | Hash of destination transaction |
destinationTxStatus | |
fromChainId | ID of sending/source chain |
toChainId | ID of destination chain |
fromAsset | Object metadata of sending token |
toAsset | Object metadata of receiving token |
srcTokenPrice | Price of fromAsset token in USD |
destTokenPrice | Price of toAsset token in USD |
fromAmount | Amount of token sent on sending chain |
toAmount | Amount of token received on the destination chain |
sender | User address on source chain |
recipient | Recipient user address on destination chain |
isSocketTx | Boolean value indicating if this transaction was performed through Socket |
refuel | Returns refuel tx status for Swap+Bridge+Refuel tx. It is returned null for non-refuel transactions. |
refuel.status | Status of Refuel in Swap+Bridge+Refuel tx. |
refuel.destinationTransactionHash | Hash of Refuel tx on destination chain |
refuel.sourceTxStatus | Status of Refuel tx on destination chain |
refuel.destinationTxStatus | Status of Refuel tx on source chain |
- For a Swap+Refuel tx (where Refuel is the Bridge), the outer
destinationTxStatus
anddestinationTransactionHash
reflect the status of the destination tx. - For a Swap+Bridge+Refuel tx, the refuel object in /bridge-status response contains the status of refuel. The main Swap+Bridge bridging transaction status and hash can be checked from
destinationTxStatus
anddestinationTransactionHash.
TEST QUERY :
Last modified 1yr ago