OpenAPI

JSON RPC

You can send transactions to the Orbiter bridge through the data obtained from the interface, currently supporting Ethereum, Arbitrum, Polygon, Optimism, zkSync Era, BSC, Arbitrum Nova, Polygon zkEVM, Scroll, Base, Linea, Mantle, Zora, Manta.

Pair Fee Configuration

Request

method: orbiter_getTradingPairs

Response

ruleList:

• pairId: Transaction pair ID

• recipient: Receiving address for user-initiated transactions

• sender: Payback maker address

• gasFee: Thousand percentage handling fee

• tradingFee: Fixed cost

• fromChain: Configuration of the user sending chain

• toChain: Configuration of the user receiving chain

  • Id: Internal ID

  • chainId：Network ID

  • networkId：Network ID

  • name：Network name

  • symbol: Token currency

  • tokenAddress: Token address

  • decimals: Token accuracy

  • maxPrice: Maximum Send Amount

  • minPrice: Minimum Send Amount

Examples

POST
{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "orbiter_getTradingPairs",
  "params": []
}

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "ruleList": [
      {
        "pairId": "1-534352:ETH-ETH",
        "recipient": "0xe4edb277e41dc89ab076a1f049f4a3efa700bce8",
        "sender": "0xe4edb277e41dc89ab076a1f049f4a3efa700bce8",
        "gasFee": "0",
        "tradingFee": "0.0015",
        "fromChain": {
          "id": "1",
          "chainId": "1",
          "networkId": "1",
          "name": "Ethereum",
          "symbol": "ETH",
          "tokenAddress": "0x0000000000000000000000000000000000000000",
          "decimals": 18,
          "maxPrice": 5,
          "minPrice": 0.005
        },
        "toChain": {
          "id": "19",
          "chainId": "534352",
          "networkId": "534352",
          "name": "Scroll",
          "symbol": "ETH",
          "decimals": 18,
          "tokenAddress": "0x0000000000000000000000000000000000000000"
        }
      }
    ]
  }
}

Obtaining Transaction Information

Request

method: orbiter_getTransactionByHash params: [transaction hash]

Response

status:

• -1: The transaction was not found

• 1: Receive the transaction

• 99: success

txList:

• side: 0.Transactions sent by users; 1.Transactions received by the user

• status: -1.The transaction was not found; 1.Receive the transaction; 99.success

• timestamp: Block timestamps for transactions

• hash: Transaction hash

• chainId: Network ID

• value: Amount of transaction

• symbol: Token of transaction

Examples

POST
{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "orbiter_getTransactionByHash",
  "params": ["0x9ec67e98b3118326286b427c9c4866f8853421cf760458c008fa336b00501e33"]
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "status": 99,
        "txList": [
            {
                "side": 0,
                "status": 99,
                "timestamp": "2023-10-24T03:15:25.000Z",
                "hash": "0x9ec67e98b3118326286b427c9c4866f8853421cf760458c008fa336b00501e33",
                "chainId": "10",
                "value": "31000000000009021",
                "symbol": "ETH"
            },
            {
                "side": 1,
                "status": 99,
                "timestamp": "2023-10-24T03:15:39.000Z",
                "hash": "0x615379e9550a8605d34af37f87472ebf42244eb257a2473fefe27a1db45443c3",
                "chainId": "8453",
                "value": "30000000000002738",
                "symbol": "ETH"
            }
        ]
    }
}

Calculation of the amount

Request

method: orbiter_calculatedAmount **params:*8 [pairId, value]

• pairId: It can be obtained from the 'orbiter_getTradingPairs' interface

• value: Amount entered from the front end of the official website

Response

• receiveValue: Amount that can be received

• actualSend: Actual amount to be sent

Examples

POST
{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "orbiter_calculatedAmount",
  "params": ["1-534352:ETH-ETH","0.005"]
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "_receiveValue": "5000000000000000",
        "_sendValue": "6500000000009019",
        "receiveValue": "0.005",
        "actualSend": "0.006500000000009019"
    }
}

Search Address History Transactions

Request

method: orbiter_getTransactionByAddress

params: [wallet address]

Response

• list: Transaction List

• count: Total number of transactions

Examples

POST
{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "orbiter_getTransactionByAddress",
  "params": ["0x72c91e88f3a2b2103c6d821e1935b2f5a6c3a871"]
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "list": [
            {
                "fromInternalId": 7,
                "toInternalId": 16,
                "fromChainId": "10",
                "toChainId": "42170",
                "fromHash": "0xb2adde2716b88313040b04814abf059119a638b7863968dfac3491586972189f",
                "toHash": "0x94de877a6674a5ee6d0abc8aa70a49b94d4d7e08e597e31f19b6d2c5421bb321",
                "fromSymbol": "ETH",
                "fromTimestamp": "2023-10-24T06:05:43.000Z",
                "toTimestamp": "2023-10-24T06:05:48.000Z",
                "fromValue": "0.005500000000009016",
                "toValue": "0.004990000000000023",
                "status": 99
            }
        ],
        "count": 1
    }
}