Skip to content

Overview

Xahau Network Data API provided by the InFTF (0.1b)

Section titled “Xahau Network Data API provided by the InFTF (0.1b)”

Introduction

  • The current version of this API offers live Xahau DEX (IOU trades) and ledger info data.

  • The API is a middleware layer with multiple data providers.

  • This makes it more flexible extendable.

Data providers

  • A data provider is providing data for the API, e.g. a time series database, a graph database, a full history xahaud node, an API or similar. These providers should be scalable.

  • Rather than relying on the data providers to supply stored xahaud data, such as object states and transactions, a xahaud data provider should be used to fetch validated data only, using the data provider mainly as an “index” (where applicable).

Response data

  • The API might limit the number of returned objects based on various factors

  • This is indicated through the x-more-data header in the response.

  • If set to true, you can use the skip query parameter to get more data with a second request

  • Set the skip parameter to the number of objects you already retrieved

Response Headers

  • Each status code 200 response has the following response headers:

  • x-ratelimit-limit: Maximum number of requests in the rate limit window.

  • x-ratelimit-remaining: Number of remaining request in current rate limit window.

  • x-ratelimit-reset: The seconds until the current rate limit window resets.

  • x-has-more-data: If available and set to true, more data can be fetched using skip

Cross-Origin Resource Sharing

  • This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec.

  • That allows cross-domain communication from the browser.

  • All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

Section titled “ Authentication ”