The Ardor API

From Nxt Wiki
Jump to: navigation, search

1 Description

The Ardor API allows interaction with Ardor nodes using HTTP requests to port 27876. Most HTTP requests can use either the GET or POST methods, but some API calls accept only the POST method for security reasons. Responses are returned as JSON objects.

Most Ardor API are similar to the NXT API described here the changes to existing NXT API are explained in the Ardor migration page Each new Ardor API call is documented below, with definitions given for HTTP request parameters and JSON response fields, followed by an example:

  • The JSON response fields are each followed by one of S for string, A for array, O for object, N for number or B for boolean.
  • In the examples, the Nxt node is represented as localhost and requests and responses are formatted for easy reading; line breaks and spaces are not actually used except in some parameter values. All requests are in URL format which implies the HTTP GET method. When GET is allowed, the URL can be entered into a browser URL field but proper URL encoding is usually required (e.g., spaces in a parameter value must be replaced by + or %20). Otherwise, the URL should be used as a guide to preparing an HTTP POST request using cURL, for example.

All API calls can be viewed and tested at http://localhost:27876/test while the local server node is running. For specific API calls, use http://localhost:27876/test?requestType=specificRequestType.

This document corresponds to Ardor version 2.0.3e.

2 Table Of Contents

3 Coin Exchange Operations

3.1 Exchange Child Chain Coins

Exchange chain coin with another chain coin. This transaction is saved on the source chain unless the exchange chain is Ardor, in which case the transaction is stored on the Ardor chain.

Request:

  • requestType is exchangeCoins
  • chain is the source chain id
  • exchange the target chain id
  • quantityQNT is the quantity (in QNT) of the source chain coin
  • priceNQTPerCoin is the exchange price (in whole units)