Skip to content

Commit 764d200

Browse files
authored
Candlestick API Reference (#2857)
1 parent 99f5d12 commit 764d200

29 files changed

+549
-126
lines changed

src/config/sidebar.ts

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -434,43 +434,53 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
434434
url: "data-streams/reference/overview",
435435
},
436436
{
437-
title: "REST API",
438-
url: "data-streams/reference/interface-api",
439-
},
440-
{
441-
title: "WebSocket",
442-
url: "data-streams/reference/interface-ws",
443-
},
444-
{
445-
title: "Authentication",
446-
url: "data-streams/reference/authentication",
437+
title: "Data Streams Reference",
438+
url: "data-streams/reference/data-streams-api",
447439
children: [
448440
{
449-
title: "JavaScript examples",
450-
url: "data-streams/reference/authentication/javascript-examples",
441+
title: "Authentication",
442+
url: "data-streams/reference/data-streams-api/authentication",
443+
children: [
444+
{
445+
title: "JavaScript examples",
446+
url: "data-streams/reference/data-streams-api/authentication/javascript-examples",
447+
},
448+
{
449+
title: "TypeScript examples",
450+
url: "data-streams/reference/data-streams-api/authentication/typescript-examples",
451+
},
452+
{
453+
title: "Go examples",
454+
url: "data-streams/reference/data-streams-api/authentication/go-examples",
455+
},
456+
{
457+
title: "Rust examples",
458+
url: "data-streams/reference/data-streams-api/authentication/rust-examples",
459+
},
460+
],
461+
},
462+
{
463+
title: "API Reference",
464+
url: "data-streams/reference/data-streams-api/interface-api",
451465
},
452466
{
453-
title: "TypeScript examples",
454-
url: "data-streams/reference/authentication/typescript-examples",
467+
title: "WebSocket Reference",
468+
url: "data-streams/reference/data-streams-api/interface-ws",
455469
},
456470
{
457-
title: "Go examples",
458-
url: "data-streams/reference/authentication/go-examples",
471+
title: "SDK References",
472+
url: "data-streams/reference/data-streams-api/go-sdk",
473+
highlightAsCurrent: ["data-streams/reference/data-streams-api/rust-sdk"],
459474
},
460475
{
461-
title: "Rust examples",
462-
url: "data-streams/reference/authentication/rust-examples",
476+
title: "Onchain report verification (EVM chains)",
477+
url: "data-streams/reference/data-streams-api/onchain-verification",
463478
},
464479
],
465480
},
466481
{
467-
title: "SDK References",
468-
url: "data-streams/reference/go-sdk",
469-
highlightAsCurrent: ["data-streams/reference/rust-sdk"],
470-
},
471-
{
472-
title: "Onchain report verification (EVM chains)",
473-
url: "data-streams/reference/onchain-verification",
482+
title: "Candlestick API",
483+
url: "data-streams/reference/candlestick-api",
474484
},
475485
],
476486
},

src/content/data-streams/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Read the [Getting Started](/data-streams/getting-started) guide to learn how to
123123

124124
Active-active is a system configuration strategy where redundant systems remain active simultaneously to serve requests. Incoming requests are distributed across all active resources and load-balanced to provide high availability, scalability, and fault tolerance. This strategy is the opposite of active-passive where a secondary system remains inactive until the primary system fails.
125125

126-
The Data Streams API services use an active-active setup as a highly available and resilient architecture across multiple distributed and fully isolated origins. This setup ensures that the services are operational even if one origin fails, which provides robust fault tolerance and high availability. This configuration applies to both the [REST API](/data-streams/reference/interface-api) and the [WebSocket API](/data-streams/reference/interface-ws). A global load balancer seamlessly manages the system to provide automated and transparent failovers. For advanced use cases, the service publishes available origins using HTTP headers, which enables you to interact directly with specific origin locations if necessary.
126+
The Data Streams API services use an active-active setup as a highly available and resilient architecture across multiple distributed and fully isolated origins. This setup ensures that the services are operational even if one origin fails, which provides robust fault tolerance and high availability. This configuration applies to both the [REST API](/data-streams/reference/data-streams-api/interface-api) and the [WebSocket API](/data-streams/reference/data-streams-api/interface-ws). A global load balancer seamlessly manages the system to provide automated and transparent failovers. For advanced use cases, the service publishes available origins using HTTP headers, which enables you to interact directly with specific origin locations if necessary.
127127

128128
### Active-Active Setup
129129

src/content/data-streams/developer-responsibilities.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ Developers implementing Chainlink Data Streams are solely responsible for instit
8585
- **Code dependencies and imports:** Developers are responsible for ensuring the quality, reliability, and security of any dependencies or imported packages that they use with Chainlink Data Streams, and review and audit these dependencies and packages.
8686
- **Implementing Contingency Logic:** In extreme circumstances, including situations beyond the control of Chainlink node operators, Chainlink Data Streams may experience periods of unavailability or performance degradation. When a WebSocket connection is dropped, user systems must manage reconnections effectively. Developers are responsible for creating contingency plans tailored to their specific application needs, such as:
8787
- Implementing the [Data Streams Architecture](/data-streams/architecture),
88-
- Adopting an [active-active](/data-streams/architecture#active-active-multi-site-deployment) deployment strategy and [configuring the SDK](/data-streams/reference/go-sdk#config-struct) to support multiple concurrent WebSocket connections,
89-
- Retrieving any potentially missing reports via the [REST API](/data-streams/reference/interface-api).
88+
- Adopting an [active-active](/data-streams/architecture#active-active-multi-site-deployment) deployment strategy and [configuring the SDK](/data-streams/reference/data-streams-api/go-sdk#config-struct) to support multiple concurrent WebSocket connections,
89+
- Retrieving any potentially missing reports via the [REST API](/data-streams/reference/data-streams-api/interface-api).
9090

9191
### Additional Considerations on Data Usage and Verification
9292

src/content/data-streams/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ You can access Chainlink Data Streams through SDKs and APIs, allowing you to bui
7878

7979
Access data directly through REST APIs or WebSocket connections using our SDKs:
8080

81-
- **[Go SDK](/data-streams/reference/go-sdk)** - Full-featured SDK with comprehensive examples
82-
- **[Rust SDK](/data-streams/reference/rust-sdk)** - High-performance SDK for Rust applications
83-
- **[REST API](/data-streams/reference/interface-api)** or **[WebSocket](/data-streams/reference/interface-ws)** - Direct access to Data Streams endpoints
81+
- **[Go SDK](/data-streams/reference/data-streams-api/go-sdk)** - Full-featured SDK with comprehensive examples
82+
- **[Rust SDK](/data-streams/reference/data-streams-api/rust-sdk)** - High-performance SDK for Rust applications
83+
- **[REST API](/data-streams/reference/data-streams-api/interface-api)** or **[WebSocket](/data-streams/reference/data-streams-api/interface-ws)** - Direct access to Data Streams endpoints
8484

8585
### Getting started
8686

@@ -90,7 +90,7 @@ Access data directly through REST APIs or WebSocket connections using our SDKs:
9090

9191
1. Try the API: Follow our [hands-on tutorial](/data-streams/tutorials/api-go) to fetch and decode your first report.
9292

93-
1. Implement Verification: Add [onchain verification](/data-streams/reference/onchain-verification) to ensure data authenticity in your smart contracts.
93+
1. Implement Verification: Add [onchain verification](/data-streams/reference/data-streams-api/onchain-verification) to ensure data authenticity in your smart contracts.
9494

9595
### Streams Trade: An alternative implementation
9696

0 commit comments

Comments
 (0)