Skip to content
ChordChordChord Docs

Bridge status

GET
/crosschain/status
curl --request GET \
  --url 'https://api.getchord.xyz/v1/crosschain/status?requestId=example&provider=lifi'

Status of a bridge by its request id or deposit hash: waiting · depositing · pending · submitted · success · delayed · refund · failure · unknown.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
requestId
required
string
/^0x[a-fA-F0-9]{64}$/

Request id (or the deposit tx hash on LI.FI).

provider
string
Allowed values: lifi relay

Bridge provider. Chord uses lifi.

fromChain
integer
toChain
integer

Responses

Section titled “ Responses ”

200

Section titled “200”
Media typeapplication/json
object
status
string
Allowed values: waiting depositing pending submitted success delayed refund failure unknown
substatus
string
inTxHashes
Array<string>
txHashes
Array<string>
explorerLink
string
updatedAt

Unix time, milliseconds — when the server built this answer.

integer
Example
{
  "status": "waiting"
}

400

Section titled “400”

Invalid parameters — error names the check that failed (INVALID_PARAMS, BAD_ADDRESS, BAD_LIMIT, BAD_HOURS, …).

Media typeapplication/json

Every non-2xx body.

object
error
required

Stable machine code, e.g. INVALID_PARAMS, NOT_READY, RATE_LIMIT_EXCEEDED.

string
message

For humans.

string
statusCode

HTTP status, when included.

integer
Example
{
  "error": "INVALID_PARAMS",
  "message": "amount must be an integer string in the token's smallest unit"
}

429

Section titled “429”

Over the per-minute limit (RATE_LIMIT_EXCEEDED). Read X-RateLimit-Reset and back off.

Media typeapplication/json

Every non-2xx body.

object
error
required

Stable machine code, e.g. INVALID_PARAMS, NOT_READY, RATE_LIMIT_EXCEEDED.

string
message

For humans.

string
statusCode

HTTP status, when included.

integer
Example
{
  "error": "INVALID_PARAMS",
  "message": "amount must be an integer string in the token's smallest unit"
}

502

Section titled “502”

The routing engine or an upstream did not answer (ENGINE_ERROR, ROUTE_ERROR).

Media typeapplication/json

Every non-2xx body.

object
error
required

Stable machine code, e.g. INVALID_PARAMS, NOT_READY, RATE_LIMIT_EXCEEDED.

string
message

For humans.

string
statusCode

HTTP status, when included.

integer
Example
{
  "error": "INVALID_PARAMS",
  "message": "amount must be an integer string in the token's smallest unit"
}

503

Section titled “503”

The lane behind this endpoint is not ready or not enabled here (NOT_READY, CHAIN_NOT_ENABLED, NOT_ENABLED, *_UNAVAILABLE). Retry later; do not treat it as an empty answer.

Media typeapplication/json

Every non-2xx body.

object
error
required

Stable machine code, e.g. INVALID_PARAMS, NOT_READY, RATE_LIMIT_EXCEEDED.

string
message

For humans.

string
statusCode

HTTP status, when included.

integer
Example
{
  "error": "INVALID_PARAMS",
  "message": "amount must be an integer string in the token's smallest unit"
}