Getting Started

Yuzu makes it super easy to get up and running with financial data in no time. Build a stock tracking app, a portfolio-tracker, or a trading terminal in minutes with no data engineering required.

Or, keep reading to make your first API call.

The GraphQL API is the easiest way to start fetching market data. Check out the sample below to make a simple API request to fetch data about whether the market is currently open.

Terminal

JS/TS

curl -H "Authorization: Bearer demo-2uNYsk9YJFy" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{"query": "query { usMarketHours { openNow } }" }' \
     https://graph.yuzu.dev/graphql

Copy

fetch('https://graph.yuzu.dev/graphql', {
  method: 'POST',
  body: JSON.stringify({
    query: "query { usMarketHours { openNow } }"
  }),
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer demo-2uNYsk9YJFy`
  }
}).then(r => r.json())
  .then(json => console.log(json))

Copy

Our streaming API makes it dead simple to start streaming real-time data for any asset. The Yuzu API supports both Websockets and Server-sent events. Here's an example:

Terminal

JS/TS

$	`curl --no-buffer \ 'https://sse.yuzu.dev/sse?token=demo-2uNYsk9YJFy&streams=S:T:AAPL,C:T:ETH-USD'`

Copy

const streams = ['S:BBO:AAPL', 'C:T:BTC-USD'];
const token = 'demo-2uNYsk9YJFy';
const url = `wss://ws.yuzu.dev/ws?token=${token}&streams=${streams.join(',')}`;
const socket = new WebSocket(url);
socket.addEventListener('open', () => { console.log('Connected'); });
socket.addEventListener('message', event => {
  console.log(JSON.parse(event.data));
});

Copy

To get started, sign up for a free account, and head over to the API Keys section of your dashboard to create an API key.

You can read more about how API authorization works here.

The Yuzu Platform

🍋 Yuzu

Getting Started

Guides

Recipes

Streaming Reference

GraphQL Reference

Making your first API call

Start streaming market data

Get your API key

What's Next?

Check out our guides

Authorization

Setup Yuzu with Apollo Client