Connect to the live update stream

curl --request GET \
  --url https://api.sand.etherfuse.com/ramp/ws \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sand.etherfuse.com/ramp/ws', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sand.etherfuse.com/ramp/ws"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

WebSocket

Connect to the live update stream

Opens a WebSocket that streams order_updated events for your organization. Authenticate with a token from POST /ramp/ws-api-token passed as the token query parameter; a browser cannot set an Authorization header on a WebSocket upgrade. The token is single-use and expires in 30 seconds. Each frame signals that an order changed; re-read the order with GET /ramp/order/{order_id} for the authoritative state, including any pending approval package. Connect over wss (for example wss://api.etherfuse.com/ramp/ws?token=...).

GET

ramp

curl --request GET \
  --url https://api.sand.etherfuse.com/ramp/ws \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sand.etherfuse.com/ramp/ws', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sand.etherfuse.com/ramp/ws"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

Authorizations

Authorization

string

header

required

API key sent in the Authorization header.

Query Parameters

token

string

required

Single-use, org-scoped token from POST /ramp/ws-api-token. Expires in 30 seconds.

Response

Switching Protocols: the connection is upgraded to a WebSocket and streams order_updated events.

Mint WebSocket token Swap assets

⌘I