📔API Collection

Environment

Name	Value
Production	https://api.orbiter.finance/sdk
Testnet	https://openapi2.orbiter.finance/sdk

Demo SourceCode： https://github.com/Orbiter-Finance/openapi-example

Preview Demo：click me

Chain List

GEThttps://api.orbiter.finance/sdk/chains

Header parameters

Response

200

OK

Body

application/json

status*string

message*string

result*array of object

Request

JavaScriptCurl

const response = await fetch('https://api.orbiter.finance/sdk/chains', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text",
  "message": "text",
  "result": [
    {
      "chainId": "text",
      "networkId": "text",
      "internalId": "text",
      "name": "text",
      "contract": {
        "0xd9d74a29307cc6fc8bf424ee4217f1a587fbc8dc": "text",
        "0x3be8b60ddf9feff6b2426e47a7619d7cbc786d97": "text",
        "0xc741900276cd598060b0fe6594fbe977392928f4": "text",
        "0x752bc92211d1ecbb31f84e57c9dfc39a15df9cfa": "text",
        "0x6a065083886ec63d274b8e1fe19ae2ddf498bfdd": "text",
        "0x0173f81c529191726c6e7287e24626fe24760ac44dae2a1f7e02080230f8458b": "text",
        "0x653f25dc641544675338cb47057f8ea530c69b78": "text",
        "0x3191f40de6991b1bb1f61b7cec43d62bb337786b": "text",
        "0xbf3922a0cebbcd718e715e83d9187cc4bba23f11": "text",
        "0x13e46b2a3f8512ed4682a8fb8b560589fe3c2172": "text",
        "0xbea3c3c4f00799b9b053f7ad25024d85e1ad049a": "text",
        "0x2598d7bc9d3b4b6124f3282e49eee68db270f516": "text"
      },
      "nativeCurrency": {
        "name": "text",
        "symbol": "text",
        "coinKey": "text",
        "address": "text"
      },
      "tokens": [
        {
          "name": "text",
          "symbol": "text",
          "coinKey": "text",
          "address": "text"
        }
      ]
    }
  ]
}

Router List

GEThttps://api.orbiter.finance/sdk/routers/v2

Query parameters

Header parameters

Response

200

OK

Body

application/json

status*string

message*string

result*array of object

Request

JavaScriptCurl

const response = await fetch('https://api.orbiter.finance/sdk/routers/v2', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text",
  "message": "text",
  "result": [
    {
      "line": "text",
      "endpoint": "text",
      "srcChain": "text",
      "tgtChain": "text",
      "srcToken": "text",
      "tgtToken": "text",
      "maxAmt": "text",
      "minAmt": "text",
      "tradeFee": "text",
      "withholdingFee": "text",
      "vc": "text",
      "state": "text"
    }
  ]
}

Cross Chain Transaction Status

GEThttps://api.orbiter.finance/sdk/transaction/status/{hash}

Path parameters

hash*string

Example: "0x791ff2e09d2190bd215e1e0160807e14979ded20de510a43f39640ee462155d9"

Header parameters

Response

200

OK

Body

application/json

status*string

message*string

result*CrossChainTransactionStatus (object)

Request

JavaScriptCurl

const response = await fetch('https://api.orbiter.finance/sdk/transaction/status/{hash}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text",
  "message": "text",
  "result": {
    "chainId": "text",
    "hash": "text",
    "sender": "text",
    "receiver": "text",
    "amount": "text",
    "symbol": "text",
    "timestamp": "text",
    "targetId": "text",
    "targetAmount": "text",
    "targetSymbol": "text",
    "targetChain": "text"
  }
}

Simulation calcAmount

GEThttps://api.orbiter.finance/sdk/routers/simulation/receiveAmount

Query parameters

Header parameters

Response

200

OK

Body

application/json

status*string

message*string

result*object

Request

JavaScriptCurl

const response = await fetch('https://api.orbiter.finance/sdk/routers/simulation/receiveAmount', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text",
  "message": "text",
  "result": {
    "receiveAmount": "text",
    "router": {
      "line": "text",
      "endpoint": "text",
      "srcChain": "text",
      "tgtChain": "text",
      "srcToken": "text",
      "tgtToken": "text",
      "maxAmt": "text",
      "minAmt": "text",
      "tradeFee": "text",
      "withholdingFee": "text",
      "vc": "text",
      "state": "text"
    }
  }
}

History

GEThttps://api.orbiter.finance/sdk/transaction/history

Query parameters

Header parameters

Response

200

OK

Body

application/json

status*string

message*string

result*object

Request

JavaScriptCurl

const response = await fetch('https://api.orbiter.finance/sdk/transaction/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text",
  "message": "text",
  "result": {
    "rows": [
      {
        "sourceId": "text",
        "targetId": "text",
        "sourceChain": "text",
        "targetChain": "text",
        "sourceAmount": "text",
        "sourceMaker": "text",
        "sourceAddress": "text",
        "targetAddress": "text",
        "sourceSymbol": "text",
        "targetSymbol": "text",
        "sourceTime": "text",
        "targetTime": "text"
      }
    ]
  }
}