📔API Collection

Environment

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

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

Preview Demo：click me

Chain List

get

/chains

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnet-api.orbiter.finance/sdk/chains'

200

200

{
  "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"
        }
      ]
    }
  ]
}

OK

Token List

get

/tokens

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnet-api.orbiter.finance/sdk/tokens'

200

200

{
  "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"
      }
    ]
  }
}

OK

Cross Chain Transaction Status

get

/transaction/status/{hash}

Path parameters

hashstringrequired

Example: 0x791ff2e09d2190bd215e1e0160807e14979ded20de510a43f39640ee462155d9

Header parameters

x-forwarded-forstringrequired

Example: 222.222.222.222

x-real-ipstringrequired

Example: 1.1.1.1.1

clientstringrequired

Example: hhhhh

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnet-api.orbiter.finance/sdk/transaction/status/{hash}' \
  --header 'x-forwarded-for: text' \
  --header 'x-real-ip: text' \
  --header 'client: text'

200

200

{
  "status": "success",
  "message": "success",
  "result": {
    "chainId": "42161",
    "hash": "0xf5d774465ca98ea1c58a2de46f94b7079a0cf8ed168058eaeb22daa0c1c78a61",
    "sender": "0xdc36b20e9c5d3120b657c44a7aee7f553d0aca3e",
    "receiver": "0x8086061cf07c03559fbb4aa58f191f9c4a5df2b2",
    "amount": "0.020554000000001103",
    "symbol": "ETH",
    "timestamp": "2024-05-09T07:45:38.000Z",
    "status": 2,
    "opStatus": 99,
    "targetId": "0xbf67fd77bb1831edb5d8f0ce22f39ea79552f8192ccee1696eb4a0327479a4ab",
    "targetAmount": "0.018954000000000004",
    "targetSymbol": "ETH",
    "targetChain": "324"
  }
}

OK

Router List

get

/routers/v2

Query parameters

dealerIdstring

dealerId If present, enter

Example: 0xxxx

entrystring

If you want the entry initiated by the user to be the contract address, then pass in contract, the default is eoa

Example: eoa

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnet-api.orbiter.finance/sdk/routers/v2'

200

200

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

OK

Simulation calcAmount

get

/routers/simulation/receiveAmount

Query parameters

linestringrequired

route

Example: 1/42161-ETH/ETH

valuestringrequired

Send amount

Example: 451200000000009002

endpointstringrequired

router endpoint

Example:

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnet-api.orbiter.finance/sdk/routers/simulation/receiveAmount?line=text&value=text&endpoint=text'

200

200

{
  "status": "success",
  "message": "success",
  "params": {
    "url": "/sdk/routers/simulation/receiveAmount?line=1/42161-ETH/ETH&value=451200000000009002&nonce=5000",
    "method": "GET",
    "routes": {}
  },
  "result": {
    "receiveAmount": "449930000000005000",
    "router": {
      "line": "1/42161-ETH/ETH",
      "endpoint": "0x80C67432656d59144cEFf962E8fAF8926599bCF8",
      "endpointContract": null,
      "srcChain": "1",
      "tgtChain": "42161",
      "srcToken": "0x0000000000000000000000000000000000000000",
      "tgtToken": "0x0000000000000000000000000000000000000000",
      "maxAmt": "10",
      "minAmt": "0.001",
      "tradeFee": "150",
      "withholdingFee": "0.0012",
      "vc": "9002",
      "state": "available",
      "compRatio": 1,
      "spentTime": 60
    }
  }
}

OK

History

get

/transaction/history

Query parameters

addressstringrequired

Example: 0xe34541eb9447f0655a7e55b66493434b94fe3ba9

offsetstring

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnet-api.orbiter.finance/sdk/transaction/history?address=text'

200

200

{
  "status": "success",
  "message": "success",
  "result": {
    "count": 5,
    "offset": 0,
    "limit": 20,
    "rows": [
      {
        "sourceId": "0x7cf1be326e319bfac2317f028333275237424ded01c78e928425c926fbf8c692",
        "targetId": "0x336ca64383af0bf8882f9ddbc7dc5ec696a3ca0d08f31e35e463ab463b94c2b8",
        "sourceChain": "42161",
        "targetChain": "81457",
        "sourceAmount": "0.001800000000009040",
        "sourceMaker": "0xe4edb277e41dc89ab076a1f049f4a3efa700bce8",
        "sourceAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "targetAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "sourceSymbol": "ETH",
        "targetSymbol": "ETH",
        "status": 99,
        "sourceTime": "2024-02-29T20:22:42.000Z",
        "targetTime": "2024-02-29T20:22:53.000Z"
      },
      {
        "sourceId": "0xcf5b83c38d09ef9205bacdb01285ff48c44cab71b7983b84f57ea582d83807d4",
        "targetId": "0xf084e6d32fb22efc771f85e3c94115ad4a3b9074f0d0dc17ae6b0a729f7fc6c6",
        "sourceChain": "42161",
        "targetChain": "81457",
        "sourceAmount": "0.010800000000009040",
        "sourceMaker": "0xe4edb277e41dc89ab076a1f049f4a3efa700bce8",
        "sourceAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "targetAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "sourceSymbol": "ETH",
        "targetSymbol": "ETH",
        "status": 99,
        "sourceTime": "2024-02-29T20:12:54.000Z",
        "targetTime": "2024-02-29T20:13:07.000Z"
      },
      {
        "sourceId": "0x5bffdd85180004338d27bd0439576b6ddc185e068ff8d729cc5173806de990fd",
        "targetId": "0x8ce2eee847ad9eacf6a7738e4ef307a959bb439e181a79beb54b9937f0f35551",
        "sourceChain": "81457",
        "targetChain": "42161",
        "sourceAmount": "0.011000000000009002",
        "sourceMaker": "0x80c67432656d59144ceff962e8faf8926599bcf8",
        "sourceAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "targetAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "sourceSymbol": "ETH",
        "targetSymbol": "ETH",
        "status": 99,
        "sourceTime": "2024-02-29T20:11:55.000Z",
        "targetTime": "2024-02-29T20:12:04.000Z"
      },
      {
        "sourceId": "0xf8caa5f5fac01f279a199d761a0352b544da6badcdc6e4d3b47dd678f3264214",
        "targetId": "0x406f5eded2b5b4d29386e76e4800243c4c7c6d6c6e3e02aa946b94b8a09214fd",
        "sourceChain": "81457",
        "targetChain": "42161",
        "sourceAmount": "0.011000000000009002",
        "sourceMaker": "0xe4edb277e41dc89ab076a1f049f4a3efa700bce8",
        "sourceAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "targetAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "sourceSymbol": "ETH",
        "targetSymbol": "ETH",
        "status": 99,
        "sourceTime": "2024-02-29T20:10:39.000Z",
        "targetTime": "2024-02-29T20:10:51.000Z"
      },
      {
        "sourceId": "0xddbcfb234f8f56c499646db3b098ae71395d821ddf859d69bf465ee3dec1b2e0",
        "targetId": "0xb33efd68eeffb3b9f498af86a6b4aaa092221126d9d2ecff32abe18aa44fc487",
        "sourceChain": "1",
        "targetChain": "81457",
        "sourceAmount": "0.097625000000009040",
        "sourceMaker": "0x80c67432656d59144ceff962e8faf8926599bcf8",
        "sourceAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "targetAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
        "sourceSymbol": "ETH",
        "targetSymbol": "ETH",
        "status": 99,
        "sourceTime": "2024-02-29T20:07:47.000Z",
        "targetTime": "2024-02-29T20:08:13.000Z"
      }
    ]
  }
}

OK

Get User Opints

get

/opoints/user/{address}

Path parameters

addressstringrequired

wallet address

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnet-api.orbiter.finance/sdk/opoints/user/{address}'

200

200

{
  "status": "success",
  "message": "success",
  "result": {
    "address": "0xefc6089224068b20197156a91d50132b2a47b908",
    "points": 84,
    "summary": {
      "basePoint": 18,
      "activityPoint": 63,
      "dappPoint": 0,
      "inscriptionPoint": 0,
      "tgBindPoint": 3,
      "activePlatformPoint": 0,
      "thirdPartyPoint": 0
    }
  }
}

OK