Skip to content

Commit 730329f

Browse files
khadnikhadni
committed
nit
1 parent e4eadee commit 730329f

File tree

4 files changed

+29
-26
lines changed

4 files changed

+29
-26
lines changed

‎src/content/data-streams/reference/candlestick-api/index.mdx‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ metadata:
99
---
1010

1111
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12+
import { CopyText } from "@components"
1213

1314
<DataStreams section="dsNotes" />
1415

@@ -20,9 +21,9 @@ The API provides both historical candlestick data through the [history endpoints
2021

2122
## Domains
2223

23-
| Description | Testnet URL | Mainnet URL |
24-
| :----------------------- | :----------------------------------------------- | :--------------------------------------- |
25-
| Candlestick API endpoint | `https://priceapi.testnet-dataengine.chain.link` | `https://priceapi.dataengine.chain.link` |
24+
| <div style="width: 180px;">Description</div> | Testnet URL | Mainnet URL |
25+
| :------------------------------------------- | :---------------------------------------------------------------------- | :-------------------------------------------------------------- |
26+
| Candlestick API endpoint | <CopyText text="https://priceapi.testnet-dataengine.chain.link" code /> | <CopyText text="https://priceapi.dataengine.chain.link" code /> |
2627

2728
## API Endpoints
2829

@@ -175,7 +176,7 @@ curl -X GET \
175176
| `l` | `array` | Array of numbers (the low (min) value of each candle). |
176177
| `v` | `array` | Array of numbers (the volume of each candle. Not currently supported). |
177178

178-
> **Note**: If candles cannot be found for the given symbol/time period, a response with empty arrays will be provided. eg: `{ "s": "ok", "t": [], "c": [], "o": [], "h": [], "l": [], "v": [] }`
179+
> **Note**: If candles cannot be found for the given symbol/time period, a response with empty arrays will be provided. E.g., `{ "s": "ok", "t": [], "c": [], "o": [], "h": [], "l": [], "v": [] }`
179180
180181
##### Error Responses
181182

@@ -219,12 +220,12 @@ curl -X GET \
219220
}
220221
```
221222

222-
| Field | Type | Description |
223-
| :-------- | :------- | :-------------------------------------------------------------------------------------------------- |
224-
| `s` | `string` | The status of the request. |
225-
| `candles` | `array` | Array of arrays of numbers. Each array candle contains: `[ time, open, high, low, close, volume ]`. |
223+
| <div style="width: 80px;">Field</div> | <div style="width: 80px;">Type</div> | Description |
224+
| :------------------------------------ | :----------------------------------- | :-------------------------------------------------------------------------------------------------- |
225+
| `s` | `string` | The status of the request. |
226+
| `candles` | `array` | Array of arrays of numbers. Each array candle contains: `[ time, open, high, low, close, volume ]`. |
226227

227-
> **Note**: If candles cannot be found for the given symbol/time period, a response with an empty `candles` array is provided. eg: `{ "s": "ok", "candles": [] }`
228+
> **Note**: If candles cannot be found for the given symbol/time period, a response with an empty `candles` array is provided. E.g., `{ "s": "ok", "candles": [] }`
228229
229230
##### Error Responses
230231

‎src/content/data-streams/reference/data-streams-api/interface-api.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ metadata:
99
---
1010

1111
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12+
import { CopyText } from "@components"
1213

1314
<DataStreams section="dsNotes" />
1415

1516
## Domains
1617

17-
| Description | Testnet URL | Mainnet URL |
18-
| --------------------------------------- | ----------------------------------------- | --------------------------------- |
19-
| REST endpoint to query specific reports | https://api.testnet-dataengine.chain.link | https://api.dataengine.chain.link |
18+
| Description | Testnet URL | Mainnet URL |
19+
| :------------ | :----------------------------------------------------------------- | :--------------------------------------------------------- |
20+
| REST endpoint | <CopyText text="https://api.testnet-dataengine.chain.link" code /> | <CopyText text="https://api.dataengine.chain.link" code /> |
2021

2122
## Authentication
2223

‎src/content/data-streams/reference/data-streams-api/interface-ws.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ metadata:
1010
---
1111

1212
import DataStreams from "@features/data-streams/common/DataStreams.astro"
13+
import { CopyText } from "@components"
1314

1415
<DataStreams section="dsNotes" />
1516

1617
## Domains
1718

18-
| Description | Testnet URL | Mainnet URL |
19-
| ------------------------------------------------ | -------------------------------------- | ------------------------------ |
20-
| WebSocket endpoint to subscribe to price updates | wss://ws.testnet-dataengine.chain.link | wss://ws.dataengine.chain.link |
19+
| Description | Testnet URL | Mainnet URL |
20+
| :----------------- | :-------------------------------------------------------------- | :------------------------------------------------------ |
21+
| WebSocket endpoint | <CopyText text="wss://ws.testnet-dataengine.chain.link" code /> | <CopyText text="wss://ws.dataengine.chain.link" code /> |
2122

2223
## Authentication
2324

‎src/content/data-streams/reference/overview.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,26 @@ Chainlink Data Streams offers two distinct APIs for accessing low-latency market
1313

1414
### Which API should I use?
1515

16-
| Feature | [Data Streams API](./data-streams-api) | [Candlestick API](./candlestick-api) |
17-
| ----------------------- | ------------------------------------------- | --------------------------------------------- |
18-
| **Primary Use Case** | **On-chain** consumption by smart contracts | **Off-chain** analytics, charting, dashboards |
19-
| **Data Format** | Signed, verifiable data reports | Aggregated OHLC (candlestick) data |
20-
| **Interfaces** | REST API & WebSocket | REST API (including a streaming endpoint) |
21-
| **Authentication** | HMAC Signature | JWT (token-based) |
22-
| **Cryptographic Proof** | ✅ Yes (`fullReport` blob) | ❌ No |
16+
| Feature | [Data Streams API](/data-streams/reference/data-streams-api) | [Candlestick API](/data-streams/reference/candlestick-api) |
17+
| ----------------------- | ------------------------------------------------------------ | ---------------------------------------------------------- |
18+
| **Primary Use Case** | **Onchain** consumption by smart contracts | **Offchain** analytics, charting, dashboards |
19+
| **Data Format** | Signed, verifiable data reports | Aggregated OHLC (candlestick) data |
20+
| **Interfaces** | REST API & WebSocket | REST API (including a streaming endpoint) |
21+
| **Authentication** | HMAC Signature | JWT (token-based) |
22+
| **Cryptographic Proof** | ✅ Yes (`fullReport` blob) | ❌ No |
2323

2424
---
2525

2626
### Data Streams API
2727

28-
Use the [Data Streams API](./data-streams-api) for applications that require high-frequency, verifiable data for **on-chain** execution. It provides access to cryptographically signed data reports that can be verified and used by smart contracts. This API is designed for applications that depend on low-latency, tamper-proof data.
28+
Use the [Data Streams API](/data-streams/reference/data-streams-api) for applications that require high-frequency, verifiable data for **onchain** execution. It provides access to cryptographically signed data reports that can be verified and used by smart contracts. This API is designed for applications that depend on low-latency, tamper-proof data.
2929

30-
**[View the Data Streams API Reference](./data-streams-api/interface-api)**
30+
**[View the Data Streams API Reference](/data-streams/reference/data-streams-api/interface-api)**
3131

3232
---
3333

3434
### Candlestick API
3535

36-
Use the [Candlestick API](./candlestick-api) for **off-chain** applications. It provides historical open-high-low-close (OHLC) data and real-time price updates in a format compatible with the [TradingView data integration specification](https://www.tradingview.com/broker-api-docs/rest-api-spec/#tag/Data-Integration). This is ideal for building dashboards, analytics platforms, portfolio trackers, and research tools.
36+
Use the [Candlestick API](/data-streams/reference/candlestick-api) for **offchain** applications. It provides historical open-high-low-close (OHLC) data and real-time price updates in a format compatible with the [TradingView data integration specification](https://www.tradingview.com/broker-api-docs/rest-api-spec/#tag/Data-Integration). This is ideal for building dashboards, analytics platforms, portfolio trackers, and research tools.
3737

38-
**[View the Candlestick API Reference](./candlestick-api)**
38+
**[View the Candlestick API Reference](/data-streams/reference/candlestick-api)**

0 commit comments

Comments
 (0)