API Reference

Get Chains

get

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /chains HTTP/1.1
Host: api.orbiter.finance
Accept: */*

200

OK

{
    "status": "success",
    "message": "success",
    "result": [
        {
            "chainId": "1",
            "networkId": "1",
            "internalId": 1,
            "name": "Ethereum",
            "contract": {
                "0xd9d74a29307cc6fc8bf424ee4217f1a587fbc8dc": "OBSource",
                "0x3be8b60ddf9feff6b2426e47a7619d7cbc786d97": "OrbiterRouterV1",
                "0xc741900276cd598060b0fe6594fbe977392928f4": "OrbiterRouterV3",
                "0x68b5a1c02dea0958388eee5361f021018bd8dbe7": "OPoolV2",
                "0xe530d28960d48708ccf3e62aa7b42a80bc427aef": "Aggregator"
            },
            "nativeCurrency": {
                "name": "Ether",
                "symbol": "ETH",
                "decimals": 18,
                "coinKey": "ETH",
                "address": "0x0000000000000000000000000000000000000000",
                "isNative": true
            },
            "tokens": [
                {
                    "name": "Ether",
                    "symbol": "ETH",
                    "decimals": 18,
                    "coinKey": "ETH",
                    "address": "0x0000000000000000000000000000000000000000",
                    "isNative": true
                },
                {
                    "name": "Orbiter Token",
                    "symbol": "OBT",
                    "coinKey": "OBT",
                    "decimals": 18,
                    "address": "0x4af322ff4a6f2858f6b51e546b9ec499654493c5",
                    "isNative": false
                },
                {
                    "name": "Dai Stablecoin",
                    "symbol": "DAI",
                    "decimals": 18,
                    "coinKey": "DAI",
                    "address": "0x6B175474E89094C44Da98b954EedeAC495271d0F",
                    "isNative": false
                },
                {
                    "name": "USD Coin",
                    "symbol": "USDC",
                    "coinKey": "USDC",
                    "decimals": 6,
                    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
                    "isNative": false
                },
                {
                    "name": "Tether USD",
                    "symbol": "USDT",
                    "coinKey": "USDT",
                    "decimals": 6,
                    "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
                    "isNative": false
                },
                {
                    "name": "Wrapped BTC",
                    "symbol": "BTC",
                    "coinKey": "BTC",
                    "decimals": 8,
                    "address": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599",
                    "isNative": false
                },
                {
                    "name": "Hashkey",
                    "symbol": "HSK",
                    "coinKey": "HSK",
                    "decimals": 18,
                    "address": "0xe7c6bf469e97eeb0bfb74c8dbff5bd47d4c1c98a",
                    "isNative": false
                }
            ],
            "vm": "EVM"
        },
        ...
    ]
}

Get a Quote

post

Body

sourceChainIdstringRequired

Source chain ID, represents the blockchain network ID where the transaction originates

Example: 42161

destChainIdstringRequired

Destination chain ID, represents the blockchain network ID where the transaction targets

Example: 10

sourceTokenstringRequired

Source token address, represents the token contract address where the transaction originates

Example: 0x0000000000000000000000000000000000000000

destTokenstringRequired

Destination token address, represents the token contract address where the transaction targets

Example: 0x0000000000000000000000000000000000000000

amountstringRequired

Transaction amount, represents the token quantity in string format

Example: 300000000000000

userAddressstringRequired

User wallet address, represents the blockchain address of the transaction initiator

Example: 0xefc6089224068b20197156a91d50132b2a47b908

targetRecipientstringOptional

Target recipient address, represents the blockchain address of the final transaction recipient

Example: 0xefc6089224068b20197156a91d50132b2a47b908

slippagenumberOptional

Slippage tolerance, represents the acceptable price fluctuation percentage for the user

Example: 0.02

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /quote HTTP/1.1
Host: api.orbiter.finance
Content-Type: application/json
Accept: */*
Content-Length: 418

{
  "sourceChainId": "42161",
  "destChainId": "10",
  "sourceToken": "0x0000000000000000000000000000000000000000",
  "destToken": "0x0000000000000000000000000000000000000000",
  "amount": "300000000000000",
  "userAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
  "targetRecipient": "0xefc6089224068b20197156a91d50132b2a47b908",
  "slippage": 0.02,
  "feeConfig": {
    "feeRecipient": "0xefc6089224068b20197156a91d50132b2a47b908",
    "feePercent": "0.1"
  }
}

200

OK

{
  "status": "success",
  "message": "success",
  "result": {
    "fees": {
      "withholdingFee": "0.00024",
      "withholdingFeeUSD": "0.439627843425104808",
      "swapFee": "0",
      "swapFeeUSD": "0",
      "tradeFee": "0.000000018",
      "tradeFeeUSD": "0.00003297208825688286",
      "totalFee": "0.43966081551336169086",
      "priceImpactUSD": "0",
      "feeSymbol": "ETH"
    },
    "steps": [
      {
        "action": "bridge",
        "tx": {
          "data": "0x5a2c71cd00000000000000000000000000000000000000000000000000000000000000200000000000000000000000003bdb03ad7363152dfbc185ee23ebc93f0cf93fd10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000110d9316ec00000000000000000000000000000000000000000000000000000000000000000e00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000efc6089224068b20197156a91d50132b2a47b90800000000000000000000000000000000000000000000000000001b48eb57e00000000000000000000000000000000000000000000000000000000000000000726170703d30786566633630383932323430363862323031393731353661393164353031333262326134376239303826633d31302674743d307830303030303030303030303030303030303030303030303030303030303030303030303030303030266d3d35393938323030303030303030300000000000000000000000000000",
          "to": "0xe530d28960d48708ccf3e62aa7b42a80bc427aef",
          "value": "300000000000000",
          "gasLimit": "184326"
        }
      }
    ],
    "details": {
      "sourceTokenAmount": "300000000000000",
      "destTokenAmount": "59982000000000",
      "rate": "0",
      "slippageTolerance": {},
      "points": 1,
      "midTokenSymbol": "ETH",
      "minDestTokenAmount": "59982000000000"
    }
  }
}

Query Transaction

get

Path parameters

hashstringRequired

Transaction hash, represents the hash value of the transaction to be queried

Example: 0x791ff2e09d2190bd215e1e0160807e14979ded20de510a43f39640ee462155d9

Body

objectOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /transaction/{hash} HTTP/1.1
Host: api.orbiter.finance
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

OK

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

Query Transaction History

get

Path parameters

addressstringRequiredExample: 0xe34541eb9447f0655a7e55b66493434b94fe3ba9

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /transaction/address/{address} HTTP/1.1
Host: api.orbiter.finance
Accept: */*

200

OK

{
  "status": "success",
  "message": "success",
  "result": {
    "count": 5,
    "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"
      }
    ],
    "offset": 0,
    "limit": 20
  }
}