subscribe

POST

https://xrp.nownodes.io/

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Subscribe to real-time updates for various types of data in the XRP Ledger. This method establishes a subscription to receive streaming data such as transactions, ledger closes, order book changes, and more.

Body

application/json

JSON-RPC request payload.

idstring

Optional unique identifier for the subscription request.

commandstringsubscriberequired

The command name

booksArray<object>required

Array of order book specifications to subscribe to.

Show child attributes

taker_paysobjectrequired

The currency the taker would pay in the exchange.

Show child attributes

currencystring

Currency code

taker_getsobjectrequired

The currency the taker would receive in the exchange.

Show child attributes

currencystring

Currency code

issuerstring

Issuer account address

snapshotboolean

If true, include a snapshot of the current order book state. Defaults to false.

methodstringsubscribe

JSON-RPC method name.

paramsarray

Ordered JSON-RPC method parameters.

Response

200OK

HTTP 200 response for subscribe. The body contains either a successful result or a method-level JSON-RPC error.

400Bad Request

Bad Request. The request body is malformed or contains invalid JSON-RPC parameters.

401Unauthorized

Unauthorized: API key is present but rejected by the NOWNodes gateway.

405Method Not Allowed

Method Not Allowed. Returned by the NOWNodes gateway for malformed or unsupported gateway-level requests.

422Unprocessable Entity

Missing API key. The NOWNodes gateway returns plain text for this error.

500Internal Server Error

Internal Server Error. The gateway or node failed while processing the request.

curl -X POST 'https://xrp.nownodes.io/' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "Example subscribe to XRP/GateHub USD order book",
    "command": "subscribe",
    "books": [
      {
        "taker_pays": {
          "currency": "XRP"
        },
        "taker_gets": {
          "currency": "USD",
          "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
        },
        "snapshot": true
      }
    ]
  }'

const response = await fetch('https://xrp.nownodes.io/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "id": "Example subscribe to XRP/GateHub USD order book",
      "command": "subscribe",
      "books": [
        {
          "taker_pays": {
            "currency": "XRP"
          },
          "taker_gets": {
            "currency": "USD",
            "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
          },
          "snapshot": true
        }
      ]
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://xrp.nownodes.io/')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "id": "Example subscribe to XRP/GateHub USD order book",
    "command": "subscribe",
    "books": [
      {
        "taker_pays": {
          "currency": "XRP"
        },
        "taker_gets": {
          "currency": "USD",
          "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
        },
        "snapshot": true
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "id": "Example subscribe to XRP/GateHub USD order book",
  "command": "subscribe",
  "books": [
    {
      "taker_pays": {
        "currency": "XRP"
      },
      "taker_gets": {
        "currency": "USD",
        "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
      },
      "snapshot": True
    }
  ]
}

response = requests.post('https://xrp.nownodes.io/', json=payload)
data = response.json()

const response = await fetch('https://xrp.nownodes.io/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "id": "Example subscribe to XRP/GateHub USD order book",
      "command": "subscribe",
      "books": [
        {
          "taker_pays": {
            "currency": "XRP"
          },
          "taker_gets": {
            "currency": "USD",
            "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
          },
          "snapshot": true
        }
      ]
    }),
});

const data = await response.json();

const endpoint = "https://xrp.nownodes.io/";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "id": "Example subscribe to XRP/GateHub USD order book",
    "command": "subscribe",
    "books": [
      {
        "taker_pays": {
          "currency": "XRP"
        },
        "taker_gets": {
          "currency": "USD",
          "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
        },
        "snapshot": true
      }
    ]
  });
console.log(result);

const response = await fetch('https://xrp.nownodes.io/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "id": "Example subscribe to XRP/GateHub USD order book",
      "command": "subscribe",
      "books": [
        {
          "taker_pays": {
            "currency": "XRP"
          },
          "taker_gets": {
            "currency": "USD",
            "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
          },
          "snapshot": true
        }
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "id": "Example subscribe to XRP/GateHub USD order book",
  "command": "subscribe",
  "books": [
    {
      "taker_pays": {
        "currency": "XRP"
      },
      "taker_gets": {
        "currency": "USD",
        "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
      },
      "snapshot": True
    }
  ]
}

response = requests.post('https://xrp.nownodes.io/', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://xrp.nownodes.io/')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "id": "Example subscribe to XRP/GateHub USD order book",
    "command": "subscribe",
    "books": [
      {
        "taker_pays": {
          "currency": "XRP"
        },
        "taker_gets": {
          "currency": "USD",
          "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
        },
        "snapshot": true
      }
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "id": "Example subscribe to XRP/GateHub USD order book",
  "command": "subscribe",
  "books": [
    {
      "taker_pays": {
        "currency": "XRP"
      },
      "taker_gets": {
        "currency": "USD",
        "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
      },
      "snapshot": true
    }
  ]
}

{
  "result": {
    "ledger_index": 105281656,
    "status": "success",
    "validated": true
  }
}

{
  "result": {
    "error": "invalidParams",
    "error_code": 31,
    "error_message": "Invalid parameters.",
    "request": {
      "method": "subscribe",
      "params": [
        {}
      ]
    },
    "status": "error"
  }
}

{
  "code": 400,
  "message": "Bad Request"
}

Unknown API_key

Method Not Allowed

Missing API_key

{
  "code": 500,
  "message": "Internal Server Error"
}

Documentation

How to migrate to NOWNodes