API docs by Redocly

Core bridge API (1.0)

Download OpenAPI specification:Download

Core bridge API is a service that responsible for the communication between blockchains.

Chains

Get chains list

Get a list of chains and tokens based on the request.

query Parameters
filter[chain_type]
Array of any

Filter by chain type. Items Value: ['evm']

include_tokens
boolean

Include tokens in the response. Items Value: [true, false]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ]
}

History

Get transaction history

Get combined history of deposits and withdrawals with filtering and pagination

query Parameters
from_address
string

Filter by from address

to_address
string

Filter by to address

source_network
string

Filter by source network

destination_network
string

Filter by destination network

token_address
string

Filter by token address

transaction_type
string

Filter by transaction type (deposits/withdrawals)

from_block
integer

Filter by minimum block number

to_block
integer

Filter by maximum block number

page
integer

Page number (default: 1)

page_size
integer

Page size (default: 10)

sort_by
string

Sort field (default: block_number)

sort_order
string

Sort order (asc/desc, default: desc)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Tokens

Get Tokens

Get the list of tokens based on the filter type and include chains flag.

query Parameters
include_chains
boolean

Include chains in the response. Items Value: [true, false]

filter[token_type]
Array of any

Filter by chain type. Items Value: ['chain']

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ]
}

Get Balance

Get the balance of an account for a token.

path Parameters
token_id
required
string

Token ID

query Parameters
address
required
string

Address of the account

chain_id
required
string

Chain ID

nft
string

NFT ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Get NFT metadata

Get the metadata of a non-fungible token based on the token ID and NFT ID.

path Parameters
token_id
required
string

Token ID

nft_id
required
string

NFT ID

query Parameters
chain_id
required
string

Chain ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Transfers

Approve

Approve is an HTTP handler that creates an approval transaction for a spender.

Request Body schema: application/json
required

Request body

required
object

Data is the data of the approval request.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": null,
  • "included": [
    ]
}

Lock Token

Generates transaction that will lock a token in the source chain.

Request Body schema: application/json
required

Request body

required
object

Data is the data of the lock request.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": null,
  • "included": [
    ]
}

Withdraw

Check if lock transaction is valid and withdraw the token from the bridge. Returns the transaction

Request Body schema: application/json
required

Request body

required
object

Data is the data of the withdrawal request.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": null,
  • "included": [
    ]
}