Price Reporter API

Overview

The Price Reporter API provides real-time prices used by Renegade to execute trades. These prices are sourced from the Binance API and are available for all Renegade-whitelisted tokens.

Features:

• Real-time execution prices
• HTTP and WebSocket access
• No authentication required

Note: These are the exact prices Renegade uses for all platform trades.

---

Getting Started

The Price Reporter API is available for Renegade's mainnet and testnet deployments.

Token addresses are environment-specific—ensure you use the correct addresses for your target network.

Environments

Environment	HTTPS	WebSocket
Mainnet	https://mainnet.price-reporter.renegade.fi:3000	wss://mainnet.price-reporter.renegade.fi:4000
Testnet	https://testnet.price-reporter.renegade.fi:3000	wss://testnet.price-reporter.renegade.fi:4000

Authentication

No authentication is required to access the Price Reporter API. All HTTP and WebSocket endpoints are publicly accessible.

Quickstart Examples

Get Current Price (HTTP via Javascript)

async function getPrice(topic) {
  const response = await fetch(
    `https://mainnet.price-reporter.renegade.fi:3000/price/${topic}`
  )
  if (!response.ok) {
    const error = await response.text()
    throw new Error(error)
  }
  const price = await response.text()
  return parseFloat(price)
}

// Example usage:
getPrice("renegade-0x82af49447d8a07e3bd95bd0d56f35241523fbab1")
  .then(console.log)
  .catch(console.error)

Subscribe to Price Updates (WebSocket via Javascript)

const ws = new WebSocket("wss://mainnet.price-reporter.renegade.fi:4000")

ws.onmessage = (event) => {
  console.log("Received:", event.data)
}

ws.onopen = () => {
  ws.send(
    JSON.stringify({
      method: "subscribe",
      topic: "renegade-0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
    })
  )
}

---

Price Topic Format

Price topics are used to specify tokens when querying prices or subscribing to updates. The format is:

renegade-{baseTokenAddress}

Component	Description
renegade	Exchange identifier (always "renegade")
baseTokenAddress	Contract address of the base token

Example (WETH on Arbitrum One):

renegade-0x82af49447d8a07e3bd95bd0d56f35241523fbab1

---

HTTP API

Get Current Price

Retrieve the current Renegade execution price for a specific token.

Endpoint

GET /price/{topic}

Path Parameters

Name	Type	Required	Description
topic	string	Yes	Token topic in the format renegade-{baseTokenAddress}

Request Example (JavaScript)

async function getPrice(topic) {
  const response = await fetch(
    `https://mainnet.price-reporter.renegade.fi:3000/price/${topic}`
  )
  if (!response.ok) {
    const error = await response.text()
    throw new Error(error)
  }
  const price = await response.text()
  return parseFloat(price)
}

// Example usage:
getPrice("renegade-0x82af49447d8a07e3bd95bd0d56f35241523fbab1")
  .then(console.log)
  .catch(console.error)

Response

• 200 OK

  • Content-Type: text/plain
  • Body:

    1610.3049999999998

• 500 Internal Server Error

  • Content-Type: text/plain
  • Body:

    Invalid (exchange, base, quote) tuple

Error Handling

Error messages are returned as plain text. The message will describe the issue, such as an invalid topic format, unsupported token, or internal server error.

Example error messages:

Invalid (exchange, base, quote) tuple: renegade does not support the pair (0x..., 0x...)

---

WebSocket API

Connection

Connect to the WebSocket endpoint for real-time price updates.

Environment	WebSocket URL
Mainnet	wss://mainnet.price-reporter.renegade.fi:4000
Testnet	wss://testnet.price-reporter.renegade.fi:4000

Subscribing to Price Updates

Subscribe to a Topic

ws.send(
  JSON.stringify({
    method: "subscribe",
    topic: "renegade-<baseTokenAddress>",
  })
)

Unsubscribe from a Topic

ws.send(
  JSON.stringify({
    method: "unsubscribe",
    topic: "renegade-<baseTokenAddress>",
  })
)

Events

Price Update

{
  "topic": "renegade-<baseTokenAddress>",
  "price": 1612.545
}

Subscription Confirmation

{
  "subscriptions": ["renegade-<baseTokenAddress>"]
}

Error Handling

Error messages are returned as plain text. The message will describe the issue, such as an invalid topic format, unsupported token, or internal server error.

Example error messages:

Invalid (exchange, base, quote) tuple: renegade does not support the pair (0x..., 0x...)

Minimal JavaScript Example

const ws = new WebSocket("wss://mainnet.price-reporter.renegade.fi:4000")

ws.onmessage = (event) => {
  try {
    const data = JSON.parse(event.data)
    if (data.subscriptions) {
      console.log("Subscribed to:", data.subscriptions)
      return
    }
    if (data.topic && data.price) {
      console.log("Price update:", data.topic, data.price)
      return
    }
  } catch {
    // If parsing fails, treat as plain text error
    console.error("WebSocket error:", event.data)
  }
}

ws.onopen = () => {
  ws.send(
    JSON.stringify({
      method: "subscribe",
      topic: "renegade-0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
    })
  )
}