{ "info": { "name": "RealTime Exchange API", "description": "https://docs.realtime.exchange/developers/rest-api", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://arc-testnet-api.realtime.exchange" }, { "key": "apiKey", "value": "" }, { "key": "apiSecret", "value": "" } ], "item": [ { "name": "Market data", "item": [ { "name": "GET /markets", "request": { "method": "GET", "description": "All listed markets (spot and perpetual) with their trading rules. Check is_active.\n\nResponse: A JSON array. Each market includes instrument_id, instrument_name, instrument_type, underlying_asset, quote_asset, price_step (tick size), amount_step, min_order_value, max_order_value, max_notional_value, max_leverage (perpetuals, omitted when unknown), mark_price and index_price (null when unavailable), funding_rate, open_interest, volume_24h, maker_fee / taker_fee (perpetuals only; null when unknown) and base_decimals / quote_decimals (18 for perpetuals).", "header": [], "url": { "raw": "{{baseUrl}}/markets", "host": [ "{{baseUrl}}" ], "path": [ "markets" ], "variable": [], "query": [ { "key": "instrument_type", "value": "PERPETUAL", "disabled": false }, { "key": "asset", "value": "AAPL", "disabled": false } ] } } }, { "name": "GET /markets/:instrument_id", "request": { "method": "GET", "description": "One market. Same object as an item of GET /markets.\n\nResponse: A market object, or 404 Instrument not found.", "header": [], "url": { "raw": "{{baseUrl}}/markets/:instrument_id", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":instrument_id" ], "variable": [ { "key": "instrument_id", "value": "AAPL-PERP" } ], "query": [] } } }, { "name": "GET /instrument/:instrument_name", "request": { "method": "GET", "description": "Alias of GET /markets/{instrument_id}.", "header": [], "url": { "raw": "{{baseUrl}}/instrument/:instrument_name", "host": [ "{{baseUrl}}" ], "path": [ "instrument", ":instrument_name" ], "variable": [ { "key": "instrument_name", "value": "AAPL-PERP" } ], "query": [] } } }, { "name": "GET /markets/:instrument_id/orderbook", "request": { "method": "GET", "description": "Alias of GET /orderbook/{instrument_name}.", "header": [], "url": { "raw": "{{baseUrl}}/markets/:instrument_id/orderbook", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":instrument_id", "orderbook" ], "variable": [ { "key": "instrument_id", "value": "AAPL-PERP" } ], "query": [] } } }, { "name": "GET /orderbook/:instrument_name", "request": { "method": "GET", "description": "Aggregated order book (open and partially filled orders).\n\nResponse: {bids: [{price, amount, orders}], asks: [...], last_updated_timestamp, checksum}", "header": [], "url": { "raw": "{{baseUrl}}/orderbook/:instrument_name", "host": [ "{{baseUrl}}" ], "path": [ "orderbook", ":instrument_name" ], "variable": [ { "key": "instrument_name", "value": "AAPL-PERP" } ], "query": [] } } }, { "name": "GET /orderbook", "request": { "method": "GET", "description": "Same as GET /orderbook/{instrument_name}, with the instrument as a query parameter.", "header": [], "url": { "raw": "{{baseUrl}}/orderbook", "host": [ "{{baseUrl}}" ], "path": [ "orderbook" ], "variable": [], "query": [ { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false } ] } } }, { "name": "GET /markets/:instrument_id/trades", "request": { "method": "GET", "description": "Recent trades for a market.\n\nResponse: A JSON array, newest first, of {trade_id, tx_hash, created_timestamp, instrument_name, is_buyer_taker, price, amount, side, trade_type, fees} with decimal prices. created_timestamp is Unix **seconds**; fees is always \"0\".", "header": [], "url": { "raw": "{{baseUrl}}/markets/:instrument_id/trades", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":instrument_id", "trades" ], "variable": [ { "key": "instrument_id", "value": "AAPL-PERP" } ], "query": [ { "key": "limit", "value": "", "disabled": true } ] } } }, { "name": "GET /instrument/:instrument_name/trade-history", "request": { "method": "GET", "description": "Recent trades for a market, wrapped with a count.\n\nResponse: {count, trade_history: [{trade_id, tx_hash, instrument_id, instrument_name, instrument_type, side, price, amount, created_timestamp}]} (timestamps in nanoseconds).", "header": [], "url": { "raw": "{{baseUrl}}/instrument/:instrument_name/trade-history", "host": [ "{{baseUrl}}" ], "path": [ "instrument", ":instrument_name", "trade-history" ], "variable": [ { "key": "instrument_name", "value": "AAPL-PERP" } ], "query": [ { "key": "limit", "value": "", "disabled": true } ] } } }, { "name": "GET /statistics/:asset/:instrument_type", "request": { "method": "GET", "description": "24-hour statistics for a market.\n\nResponse: {asset, daily_volume, daily_buy_volume, daily_trades, open_interest: {total, long, short}, index_price, mark_price, mark_price_24h_ago, mark_daily_change, mark_daily_change_pct, funding_rate, funding_daily_avg, next_funding_rate_timestamp, funding_interval_seconds, ...}", "header": [], "url": { "raw": "{{baseUrl}}/statistics/:asset/:instrument_type", "host": [ "{{baseUrl}}" ], "path": [ "statistics", ":asset", ":instrument_type" ], "variable": [ { "key": "asset", "value": "AAPL" }, { "key": "instrument_type", "value": "PERPETUAL" } ], "query": [] } } }, { "name": "GET /statistics", "request": { "method": "GET", "description": "Same as above with query parameters.", "header": [], "url": { "raw": "{{baseUrl}}/statistics", "host": [ "{{baseUrl}}" ], "path": [ "statistics" ], "variable": [], "query": [ { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false }, { "key": "asset", "value": "AAPL", "disabled": false }, { "key": "instrument_type", "value": "PERPETUAL", "disabled": false } ] } } }, { "name": "GET /funding/:instrument_name", "request": { "method": "GET", "description": "Current funding rate of a perpetual market (per hour).\n\nResponse: {funding_rate, estimated_rate, protocol_funding_rate, next_funding_time, funding_interval_seconds, funding_accrual, funding_update_interval_seconds}", "header": [], "url": { "raw": "{{baseUrl}}/funding/:instrument_name", "host": [ "{{baseUrl}}" ], "path": [ "funding", ":instrument_name" ], "variable": [ { "key": "instrument_name", "value": "AAPL-PERP" } ], "query": [] } } }, { "name": "GET /funding", "request": { "method": "GET", "description": "Same as above with instrument_name as a query parameter.", "header": [], "url": { "raw": "{{baseUrl}}/funding", "host": [ "{{baseUrl}}" ], "path": [ "funding" ], "variable": [], "query": [ { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false } ] } } }, { "name": "GET /funding-history/:instrument_name", "request": { "method": "GET", "description": "Recent hourly funding rates of a perpetual market.\n\nResponse: {funding_history: [[instrument_name, time_ns, rate, mark_price], ...]}, oldest first.", "header": [], "url": { "raw": "{{baseUrl}}/funding-history/:instrument_name", "host": [ "{{baseUrl}}" ], "path": [ "funding-history", ":instrument_name" ], "variable": [ { "key": "instrument_name", "value": "AAPL-PERP" } ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "start_time", "value": "", "disabled": true }, { "key": "end_time", "value": "", "disabled": true } ] } } }, { "name": "GET /funding-history", "request": { "method": "GET", "description": "Same as above with instrument_name as a query parameter.", "header": [], "url": { "raw": "{{baseUrl}}/funding-history", "host": [ "{{baseUrl}}" ], "path": [ "funding-history" ], "variable": [], "query": [ { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false }, { "key": "limit", "value": "", "disabled": true }, { "key": "start_time", "value": "", "disabled": true }, { "key": "end_time", "value": "", "disabled": true } ] } } }, { "name": "GET /index/:asset", "request": { "method": "GET", "description": "Index (oracle) price of an asset.\n\nResponse: An array [{asset, price, timestamp}].", "header": [], "url": { "raw": "{{baseUrl}}/index/:asset", "host": [ "{{baseUrl}}" ], "path": [ "index", ":asset" ], "variable": [ { "key": "asset", "value": "AAPL" } ], "query": [] } } }, { "name": "GET /index", "request": { "method": "GET", "description": "Index prices for every token the indexer knows (see GET /assets), or one asset via ?asset=. For a perpetual underlying that is not a token, use GET /index/{asset}.", "header": [], "url": { "raw": "{{baseUrl}}/index", "host": [ "{{baseUrl}}" ], "path": [ "index" ], "variable": [], "query": [ { "key": "asset", "value": "AAPL", "disabled": false } ] } } }, { "name": "GET /assets", "request": { "method": "GET", "description": "Tokens known to the indexer.\n\nResponse: An array of {asset_id, asset_name, symbol, address, decimals}.", "header": [], "url": { "raw": "{{baseUrl}}/assets", "host": [ "{{baseUrl}}" ], "path": [ "assets" ], "variable": [], "query": [] } } }, { "name": "GET /markets-summary", "request": { "method": "GET", "description": "Per-asset summary of spot and perpetual prices and volumes.\n\nResponse: {summaries: [{asset, index_price, spot_info?, perpetual_info?}]}", "header": [], "url": { "raw": "{{baseUrl}}/markets-summary", "host": [ "{{baseUrl}}" ], "path": [ "markets-summary" ], "variable": [], "query": [] } } } ] }, { "name": "Candles and charting", "item": [ { "name": "GET /candles", "request": { "method": "GET", "description": "OHLCV candles built from this venue's fills.\n\nResponse: An array, oldest first, of {time, close_time, open, high, low, close, volume, quote_volume, trades, average, taker_buy_volume}. Money values are exact decimal strings.", "header": [], "url": { "raw": "{{baseUrl}}/candles", "host": [ "{{baseUrl}}" ], "path": [ "candles" ], "variable": [], "query": [ { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false }, { "key": "resolution", "value": "60", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "countback", "value": "", "disabled": true } ] } } }, { "name": "GET /last-traded-tradingview/history", "request": { "method": "GET", "description": "The same candles in TradingView UDF format.\n\nResponse: {s: \"ok\", t, o, h, l, c, v}, or {s: \"no_data\"} (also for an unknown symbol; may include nextTime). Other errors are returned as HTTP 200 {s: \"error\", errmsg} (UDF convention); an unsupported resolution is a 400.", "header": [], "url": { "raw": "{{baseUrl}}/last-traded-tradingview/history", "host": [ "{{baseUrl}}" ], "path": [ "last-traded-tradingview", "history" ], "variable": [], "query": [ { "key": "symbol", "value": "AAPL-PERP", "disabled": false }, { "key": "resolution", "value": "60", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "countback", "value": "", "disabled": true } ] } } }, { "name": "GET /last-traded-tradingview/config", "request": { "method": "GET", "description": "TradingView UDF datafeed configuration (supported resolutions).", "header": [], "url": { "raw": "{{baseUrl}}/last-traded-tradingview/config", "host": [ "{{baseUrl}}" ], "path": [ "last-traded-tradingview", "config" ], "variable": [], "query": [] } } } ] }, { "name": "Account", "item": [ { "name": "GET /account", "request": { "method": "GET", "description": "Account overview — balances, equity, margin, positions, fee structures.\n\nResponse: An account object including account, equity, available_balance, balance, collaterals, positions, fee_structures, initial_margin, maintenance_margin, in_liquidation, liquidatable, leverages, realized_pnl, unrealized_pnl.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/account", "host": [ "{{baseUrl}}" ], "path": [ "account" ], "variable": [], "query": [] } } }, { "name": "GET /positions", "request": { "method": "GET", "description": "Open positions, cursor-paginated.\n\nResponse: {positions: [...], pagination: {next_cursor, prev_cursor, has_next, has_prev, limit, total_count, total_pages}}", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/positions", "host": [ "{{baseUrl}}" ], "path": [ "positions" ], "variable": [], "query": [ { "key": "instrument_type", "value": "PERPETUAL", "disabled": false }, { "key": "asset", "value": "AAPL", "disabled": false }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true }, { "key": "direction", "value": "", "disabled": true } ] } } }, { "name": "GET /open-orders", "request": { "method": "GET", "description": "Open and partially filled orders, cursor-paginated.\n\nResponse: {orders: [...], pagination}", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/open-orders", "host": [ "{{baseUrl}}" ], "path": [ "open-orders" ], "variable": [], "query": [ { "key": "instrument_type", "value": "PERPETUAL", "disabled": false }, { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false }, { "key": "asset", "value": "AAPL", "disabled": false }, { "key": "sort_order", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true }, { "key": "direction", "value": "", "disabled": true } ] } } }, { "name": "GET /orders", "request": { "method": "GET", "description": "Your open and partially filled orders, unpaginated (at most the 200 most recent).\n\nResponse: A JSON array of orders.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ], "variable": [], "query": [ { "key": "instrument_type", "value": "PERPETUAL", "disabled": false } ] } } }, { "name": "GET /orders/:order_id", "request": { "method": "GET", "description": "One of your open orders.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id" ], "variable": [ { "key": "order_id", "value": "" } ], "query": [] } } }, { "name": "GET /trade-history", "request": { "method": "GET", "description": "Your fills, cursor-paginated.\n\nResponse: {trade_history: [...], pagination}", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/trade-history", "host": [ "{{baseUrl}}" ], "path": [ "trade-history" ], "variable": [], "query": [ { "key": "instrument_type", "value": "PERPETUAL", "disabled": false }, { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false }, { "key": "asset", "value": "AAPL", "disabled": false }, { "key": "start_time", "value": "", "disabled": true }, { "key": "end_time", "value": "", "disabled": true }, { "key": "sort_order", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true }, { "key": "direction", "value": "", "disabled": true } ] } } }, { "name": "GET /order-history", "request": { "method": "GET", "description": "Filled, partially filled and cancelled orders, cursor-paginated.\n\nResponse: {order_history: [...], pagination}", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/order-history", "host": [ "{{baseUrl}}" ], "path": [ "order-history" ], "variable": [], "query": [ { "key": "instrument_type", "value": "PERPETUAL", "disabled": false }, { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false }, { "key": "asset", "value": "AAPL", "disabled": false }, { "key": "start_time", "value": "", "disabled": true }, { "key": "end_time", "value": "", "disabled": true }, { "key": "sort_order", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true }, { "key": "direction", "value": "", "disabled": true } ] } } }, { "name": "GET /position-history", "request": { "method": "GET", "description": "Closed perpetual positions (one row per position cycle), cursor-paginated.\n\nResponse: {position_history: [...], pagination}", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/position-history", "host": [ "{{baseUrl}}" ], "path": [ "position-history" ], "variable": [], "query": [ { "key": "instrument_name", "value": "AAPL-PERP", "disabled": false }, { "key": "asset", "value": "AAPL", "disabled": false }, { "key": "start_time", "value": "", "disabled": true }, { "key": "end_time", "value": "", "disabled": true }, { "key": "sort_order", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "cursor", "value": "", "disabled": true }, { "key": "direction", "value": "", "disabled": true } ] } } }, { "name": "GET /transaction-history", "request": { "method": "GET", "description": "Deposits, withdrawals and transfers.\n\nResponse: {transaction_history: [...], count}", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/transaction-history", "host": [ "{{baseUrl}}" ], "path": [ "transaction-history" ], "variable": [], "query": [ { "key": "tx_type", "value": "", "disabled": true }, { "key": "start_time", "value": "", "disabled": true }, { "key": "end_time", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "tx_status", "value": "", "disabled": true }, { "key": "sort_order", "value": "", "disabled": true } ] } } }, { "name": "GET /account/accumulated-fundings", "request": { "method": "GET", "description": "Funding accumulated on your open perpetual positions.\n\nResponse: {account, accumulated_fundings: [{instrument_id, accumulated_funding, pending_funding_fee, total_funding_fee}]} — positive accumulated_funding is in your favour.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/account/accumulated-fundings", "host": [ "{{baseUrl}}" ], "path": [ "account", "accumulated-fundings" ], "variable": [], "query": [] } } }, { "name": "GET /balance-history", "request": { "method": "GET", "description": "Your recorded account equity over time (the portfolio chart).\n\nResponse: {history: [[unix_seconds, equity], ...]}, oldest first.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/balance-history", "host": [ "{{baseUrl}}" ], "path": [ "balance-history" ], "variable": [], "query": [ { "key": "start_time", "value": "", "disabled": false }, { "key": "end_time", "value": "", "disabled": true }, { "key": "resolution", "value": "60", "disabled": false } ] } } } ] }, { "name": "Registration", "item": [ { "name": "POST /register", "request": { "method": "POST", "description": "Register a signing key for your wallet and receive an API key + secret.\n\nResponse: 201 {api_key, api_secret, account, signing_key}", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/register", "host": [ "{{baseUrl}}" ], "path": [ "register" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"account\": \"\",\n \"signing_key\": \"\",\n \"expiry\": \"\",\n \"account_signature\": \"\",\n \"signing_key_signature\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /api-key", "request": { "method": "DELETE", "description": "Revoke an API key of your account, or all of them.\n\nResponse: {success: true}; with all: true, {success: true, revoked}. 404 when the key is not found.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api-key", "host": [ "{{baseUrl}}" ], "path": [ "api-key" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"api_key\": \"\",\n \"all\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Notifications", "item": [ { "name": "GET /notifications", "request": { "method": "GET", "description": "Your notifications, newest first.\n\nResponse: A JSON array of {id, account, chain_id, notification_type, created_timestamp, is_read, metadata}. created_timestamp is Unix nanoseconds, as a string.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ], "variable": [], "query": [ { "key": "unread", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true } ] } } }, { "name": "POST /mark-as-read", "request": { "method": "POST", "description": "Mark all notifications as read. Returns the refreshed list.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/mark-as-read", "host": [ "{{baseUrl}}" ], "path": [ "mark-as-read" ], "variable": [], "query": [] } } }, { "name": "POST /notifications/clear", "request": { "method": "POST", "description": "Clear the list (older notifications are hidden, not deleted).", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/notifications/clear", "host": [ "{{baseUrl}}" ], "path": [ "notifications", "clear" ], "variable": [], "query": [] } } }, { "name": "POST /notifications/:id/read", "request": { "method": "POST", "description": "Mark one notification as read.\n\nResponse: The updated notification, or {success: true} when it is not in the current list.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/notifications/:id/read", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":id", "read" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "DELETE /notifications/:id", "request": { "method": "DELETE", "description": "Delete one notification. Always returns {success: true}.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] } } }, { "name": "GET /notification-preferences", "request": { "method": "GET", "description": "Your notification preferences.\n\nResponse: {muted_types, sound_enabled, browser_push_enabled, updated_at} (a legacy cleared_at field may also appear; it is not updated by POST /notifications/clear).", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" } ], "url": { "raw": "{{baseUrl}}/notification-preferences", "host": [ "{{baseUrl}}" ], "path": [ "notification-preferences" ], "variable": [], "query": [] } } }, { "name": "PUT /notification-preferences", "request": { "method": "PUT", "description": "Update notification preferences. Values of the wrong type are ignored.", "header": [ { "key": "API-KEY", "value": "{{apiKey}}" }, { "key": "API-SECRET", "value": "{{apiSecret}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/notification-preferences", "host": [ "{{baseUrl}}" ], "path": [ "notification-preferences" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"muted_types\": \"\",\n \"sound_enabled\": \"\",\n \"browser_push_enabled\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Service", "item": [ { "name": "GET /health", "request": { "method": "GET", "description": "Liveness. Always HTTP 200; reports whether Redis is degraded.\n\nResponse: {status, degraded, degradedDependencies, dependencies: {redis}, timestamp, environment, version}", "header": [], "url": { "raw": "{{baseUrl}}/health", "host": [ "{{baseUrl}}" ], "path": [ "health" ], "variable": [], "query": [] } } }, { "name": "GET /ready", "request": { "method": "GET", "description": "Readiness. HTTP 200 only when Redis, the RPC and the indexer all answer; otherwise 503.\n\nResponse: {status: \"ready\"|\"not_ready\", checks: {redis, rpc, indexer}, timestamp}. Each check is {ok, error?} plus extra fields (rpc.head; indexer.lag: \"unknown\" when the indexer has no /ready and only reachability was checked). error is a fixed word such as timeout, unreachable, no_head or http_503.", "header": [], "url": { "raw": "{{baseUrl}}/ready", "host": [ "{{baseUrl}}" ], "path": [ "ready" ], "variable": [], "query": [] } } }, { "name": "GET /version", "request": { "method": "GET", "description": "Backend version and runtime.\n\nResponse: {version, node, environment}", "header": [], "url": { "raw": "{{baseUrl}}/version", "host": [ "{{baseUrl}}" ], "path": [ "version" ], "variable": [], "query": [] } } }, { "name": "GET /time", "request": { "method": "GET", "description": "Server time.\n\nResponse: {time} — nanoseconds, as a string.", "header": [], "url": { "raw": "{{baseUrl}}/time", "host": [ "{{baseUrl}}" ], "path": [ "time" ], "variable": [], "query": [] } } } ] } ] }