API & WebSocket Guide

Domains

Description	Testnet URL	Mainnet URL
REST Endpoint to query specific reports	http://live-api-test.apro.com	http://live-api.apro.com

Authentication

Headers

All routes require the following two headers for user authentication:

Header	Description
Authorization	The user’s unique identifier, provided as a UUID (Universally Unique IDentifier).
X-Authorization-Timestamp	The current timestamp, with precision up to milliseconds. The timestamp must closely synchronize with the server time, allowing a maximum discrepancy of 5 seconds (by default).

API endpoints

1. Return a single report at a given timestamp

Endpoint

/api/v1/reports

Type	Description	Parameter(s)
HTTP GET	Returns a single report for a given timestamp.	feedID: A Data Streams feed ID. timestamp: The Unix timestamp for the report.

Sample request

GET /api/v1/reports?feedID=<feedID>&timestamp=<timestamp>

Sample response

{
  "report": {
    "feedID": "Hex encoded feedId.",
    "validFromTimestamp": "Report's earliest applicable timestamp (in seconds).",
    "observationsTimestamp": "Report's latest applicable timestamp (in seconds).",
    "fullReport": "A blob containing the report context and body. Encode the fee token into the payload before passing it to the contract for verification."
  }
}

2. Return a single report with the latest timestamp

Endpoint

/api/v1/reports/latest

Type	Parameter(s)
HTTP GET	feedID: A Data Streams feed ID.

Sample request

GET /api/v1/reports/latest?feedID=<feedID>

Sample response

{
  "reports": [
    {
      "feedID": "Hex encoded feedId.",
      "validFromTimestamp": "Report's earliest applicable timestamp (in seconds).",
      "observationsTimestamp": "Report's latest applicable timestamp (in seconds).",
      "fullReport": "A blob containing the report context and body. Encode the fee token into the payload before passing it to the contract for verification."
    }
    //...
  ]
}

3. Return a report for multiple FeedIDs at a given timestamp

Endpoint

/api/v1/reports/bulk

Type	Description	arameter(s)
HTTP GET	Return a report for multiple FeedIDs at a given timestamp.	feedIDs: A comma-separated list of Data Streams feed IDs. timestamp: The Unix timestamp for the reports.

Sample request

GET /api/v1/reports/bulk?feedIDs=<FeedID1>,<FeedID2>,...&timestamp=<timestamp>

Sample response

{
  "reports": [
    {
      "feedID": "Hex encoded feedId.",
      "validFromTimestamp": "Report's earliest applicable timestamp (in seconds).",
      "observationsTimestamp": "Report's latest applicable timestamp (in seconds).",
      "fullReport": "A blob containing the report context and body. Encode the fee token into the payload before passing it to the contract for verification."
    }
    //...
  ]
}

4. Return multiple sequential reports for a single FeedID, starting at a given timestamp

Endpoint

/api/v1/reports/page

Type	Description	Parameter(s)
HTTP GET	Return multiple sequential reports for a single FeedID, starting at a given timestamp.	feedID: A Data Streams feed ID. startTimestamp: The Unix timestamp for the first report. limit (optional): The number of reports to return.

Sample request

GET /api/v1/reports/page?feedID=<FeedID>&startTimestamp=<StartTimestamp>&limit=<Limit>

Sample response

{
  "reports": [
    {
      "feedID": "Hex encoded feedId.",
      "validFromTimestamp": "Report's earliest applicable timestamp (in seconds).",
      "observationsTimestamp": "Report's latest applicable timestamp (in seconds).",
      "fullReport": "A blob containing the report context and body. Encode the fee token into the payload before passing it to the contract for verification."
    }
    //...
  ]
}

5. WebSocket Connection

Establish a streaming WebSocket connection that sends reports for the given feedID(s) after they are verified.

Endpoint

/api/v1/ws

Type	Parameter(s)
WebSocket	feedIDs: A comma-separated list of Data Streams feed IDs.

Sample request

GET /api/v1/ws?feedIDs=<feedID1>,<feedID2>,...

Sample response

{
  "report": {
    "feedID": "hex encoded feedId",
    "fullReport": "a blob containing the report context + body, can be passed unmodified to the contract for verification"
  }
}

Error response codes

Status Code	Description
400 Bad Request	This error is triggered when: There is any missing/malformed query argument. Required headers are missing or provided with incorrect values.
401 Unauthorized User	This error is triggered when: Authentication fails, typically because the HMAC signature provided by the client doesn't match the one expected by the server. A user requests access to a feed without the appropriate permission or that does not exist.
500 Internal Server	Indicates an unexpected condition encountered by the server, preventing it from fulfilling the request. This error typically points to issues on the server side.
206 Missing data (/bulk endpoint only)	Indicates that at least one feed ID data is missing from the report. E.g., you requested a report for feed IDs <feedID1>, <feedID2>, and <feedID3> at a given timestamp. If data for <feedID2> is missing from the report (not available yet at the specified timestamp), you get [<feedID1 data>, <feedID3 data>] and a 206 response.