Orbiter Finance
Search
K

OpenAPI(Suggested)

openapi

v1.0.0
Base URLs:

Authentication

Bridge

GET Chain List

GET /chains
Return example
OK
{
"status": "success",
"message": "success",
"params": {
"url": "/sdk/chains",
"method": "GET",
"routes": {}
},
"result": [
{
"chainId": "1",
"networkId": "1",
"internalId": "1",
"name": "Ethereum",
"contract": {
"0xd9d74a29307cc6fc8bf424ee4217f1a587fbc8dc": "OBSource",
"0x3be8b60ddf9feff6b2426e47a7619d7cbc786d97": "OrbiterRouterV1",
"0xc741900276cd598060b0fe6594fbe977392928f4": "OrbiterRouterV3"
},
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18,
"coinKey": "ETH",
"address": "0x0000000000000000000000000000000000000000"
},
"tokens": [
{
"name": "Ether",
"symbol": "ETH",
"decimals": 18,
"coinKey": "ETH",
"address": "0x0000000000000000000000000000000000000000"
},
{
"name": "Dai Stablecoin",
"symbol": "DAI",
"decimals": 18,
"coinKey": "DAI",
"address": "0x6B175474E89094C44Da98b954EedeAC495271d0F"
},
{
"name": "USD Coin",
"symbol": "USDC",
"coinKey": "USDC",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
},
{
"name": "Tether USD",
"symbol": "USDT",
"coinKey": "USDT",
"decimals": 6,
"address": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
}
]
}
]
}

Response

Status code
Status code meaning
Description
Data model
200
OK
OK
Inline

Return data structure

status code 200
Name
Type
Required
Constraint
Chinese name
Description
» status
string
true
none
none
» message
string
true
none
none
» result
[object]
true
none
none
»» chainId
string
true
none
none
»» networkId
string
true
none
none
»» internalId
string
true
none
none
»» name
string
true
none
none
»» contract
object
true
none
none
»»» 0xd9d74a29307cc6fc8bf424ee4217f1a587fbc8dc
string
true
none
none
»»» 0x3be8b60ddf9feff6b2426e47a7619d7cbc786d97
string
false
none
none
»»» 0xc741900276cd598060b0fe6594fbe977392928f4
string
false
none
none
»»» 0x752bc92211d1ecbb31f84e57c9dfc39a15df9cfa
string
false
none
none
»»» 0x6a065083886ec63d274b8e1fe19ae2ddf498bfdd
string
false
none
none
»»» 0x0173f81c529191726c6e7287e24626fe24760ac44dae2a1f7e02080230f8458b
string
false
none
none
»»» 0x653f25dc641544675338cb47057f8ea530c69b78
string
false
none
none
»»» 0x3191f40de6991b1bb1f61b7cec43d62bb337786b
string
false
none
none
»»» 0xbf3922a0cebbcd718e715e83d9187cc4bba23f11
string
false
none
none
»»» 0x13e46b2a3f8512ed4682a8fb8b560589fe3c2172
string
true
none
none
»»» 0xbea3c3c4f00799b9b053f7ad25024d85e1ad049a
string
false
none
none
»»» 0x2598d7bc9d3b4b6124f3282e49eee68db270f516
string
false
none
none
»» nativeCurrency
object
true
none
none
»»» name
string
true
none
none
»»» symbol
string
true
none
none
»»» decimals
integer
true
none
none
»»» coinKey
string
true
none
none
»»» address
string
true
none
none
»»» id
integer
false
none
none
»» tokens
[object]
true
none
none
»»» name
string
true
none
none
»»» symbol
string
true
none
none
»»» decimals
integer
true
none
none
»»» coinKey
string
true
none
none
»»» address
string
true
none
none
»»» id
integer
true
none
none

GET Token List

GET /tokens
Return example
OK
{
"status": "success",
"message": "success",
"params": {
"url": "/sdk/tokens",
"method": "GET",
"routes": {}
},
"result": {
"1": [
{
"name": "Ether",
"symbol": "ETH",
"decimals": 18,
"coinKey": "ETH",
"address": "0x0000000000000000000000000000000000000000"
},
{
"name": "Dai Stablecoin",
"symbol": "DAI",
"decimals": 18,
"coinKey": "DAI",
"address": "0x6B175474E89094C44Da98b954EedeAC495271d0F"
},
{
"name": "USD Coin",
"symbol": "USDC",
"coinKey": "USDC",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
},
{
"name": "Tether USD",
"symbol": "USDT",
"coinKey": "USDT",
"decimals": 6,
"address": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
}
]
}
}

Response

Status code
Status code meaning
Description
Data model
200
OK
OK
Inline

Return data structure

GET Transaction Detail

GET /transaction/detail/{hash}

Request

Name
Location
Type
Required
Description
hash
path
string
Y
none
Return example
200 Response
{
"chainId": "string",
"hash": "string",
"blockNumber": "string",
"transactionIndex": "string",
"sender": "string",
"receiver": "string",
"amount": "string",
"token": "string",
"symbol": "string",
"feeAmount": "string",
"timestamp": "string",
"status": 0,
"nonce": "string"
}

Response

Status code
Status code meaning
Description
Data model
200
OK
OK
Inline

Return data structure

status code 200
Name
Type
Required
Constraint
Chinese name
Description
» chainId
string
true
none
none
» hash
string
true
none
none
» blockNumber
string
true
none
none
» transactionIndex
string
true
none
none
» sender
string
true
none
none
» receiver
string
true
none
none
» amount
string
true
none
none
» token
string
true
none
none
» symbol
string
true
none
none
» feeAmount
string
true
none
none
» timestamp
string
true
none
none
» status
integer
true
none
none
» nonce
string
true
none
none

GET Cross Chain Transaction Detail

GET /transaction/cross-chain/{hash}

Request

Name
Location
Type
Required
Description
hash
path
string
Y
none
Return example
200 Response
{
"status": "string",
"message": "string",
"result": {
"sourceId": "string",
"targetId": "string",
"sourceChain": "string",
"targetChain": "string",
"sourceAmount": "string",
"targetAmount": "string",
"sourceMaker": "string",
"targetMaker": "string",
"sourceAddress": "string",
"targetAddress": "string",
"sourceSymbol": "string",
"targetSymbol": "string",
"status": 0,
"sourceTime": "string",
"targetTime": "string",
"ruleId": null
}
}

Response

Status code
Status code meaning
Description
Data model
200
OK
OK
Inline

Return data structure

status code 200
Name
Type
Required
Constraint
Chinese name
Description
» status
string
true
none
none
» message
string
true
none
none
» result
object
true
none
none
»» sourceId
string
true
none
none
»» targetId
string
true
none
none
»» sourceChain
string
true
none
none
»» targetChain
string
true
none
none
»» sourceAmount
string
true
none
none
»» targetAmount
string
true
none
none
»» sourceMaker
string
true
none
none
»» targetMaker
string
true
none
none
»» sourceAddress
string
true
none
none
»» targetAddress
string
true
none
none
»» sourceSymbol
string
true
none
none
»» targetSymbol
string
true
none
none
»» status
integer
true
none
none
»» sourceTime
string
true
none
none
»» targetTime
string
true
none
none
»» ruleId
null
true
none
none

GET Router List

GET /routers

Request

Name
Location
Type
Required
Description
dealerId
query
string
N
none
Return example
200 Response
{
"line": "string",
"endpoint": "string",
"endpointContract": null,
"srcChain": "string",
"tgtChain": "string",
"srcToken": "string",
"tgtToken": "string",
"maxAmt": "string",
"minAmt": "string",
"tradeFee": "string",
"withholdingFee": "string",
"vc": "string",
"state": "string",
"compRatio": 0,
"spentTime": 0
}

Response

Status code
Status code meaning
Description
Data model
200
OK
Success
Inline

Return data structure

status code 200
Name
Type
Required
Constraint
Chinese name
Description
» line
string
true
none
line name
» endpoint
string
true
none
Entrance EOA address
» endpointContract
null
false
none
Entry contract address
» srcChain
string
true
none
Source chain
» tgtChain
string
true
none
Target chain
» srcToken
string
true
none
Source currency
» tgtToken
string
true
none
Target currency
» maxAmt
string
true
none