Attestation status

GET

/bridge2/status

const url = 'https://api.getchord.xyz/v1/bridge2/status?srcDomain=1&tx=example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.getchord.xyz/v1/bridge2/status?srcDomain=1&tx=example'

Iris status for a burn transaction: not_found, pending or complete with the message and attestation when ready.

Parameters

Query Parameters

srcDomain

required

integer

required

Transaction hash.

string

/^0x[a-fA-F0-9]{64}$/

The burn transaction.

Responses

200

application/json

object

status

string

Allowed values: not_found pending complete

srcDomain

integer

Transaction hash.

string

/^0x[a-fA-F0-9]{64}$/

message

string | null

attestation

string | null

eventNonce

string | null

decoded

object | null

Example

{
  "status": "not_found"
}

400

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

application/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

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.

application/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"
}