` |
| `ltp` | Last traded price (already divided — use as-is) |
| `change` | Price change since previous close |
| `changePct` | Percentage change |
| `bid` / `ask` | Best bid / ask price |
| `high` / `low` | Intraday high / low |
| `ltq` | Last traded quantity |
| `ltt` | Last trade time (epoch seconds) |
| `priceDecimals` | How many decimal places to display |
| `ts` | Our server timestamp (epoch ms) |
---
## 5. Discovering instruments programmatically
```
GET https://mkt-ticker-data-production.up.railway.app/api/public/instruments
?token=YOUR_TOKEN
&category=CRYPTO (optional — filter by segment)
&q=BTC (optional — substring match on symbol/name)
&limit=200 (optional — default 500)
```
Response:
```json
{
"total": 10,
"categories": ["CRYPTO", "FOREX", "USSTOCK", ...],
"items": [
{
"token": 2101,
"exchange": 19,
"symbol": "BTCUSD",
"name": "Bitcoin / USD",
"category": "CRYPTO",
"priceDecimals": 2,
"qtyDecimals": 2
},
...
]
}
```
The `categories` array lists only segments your token is allowed to access.
---
## 6. Events emitted by the client
```js
feed.on('hello', (info) => {
// Sent once on connect. Tells you which subs were accepted/denied.
console.log(info);
// { client: "Your Name", allowedSegments: [...], subscribed: 5, denied: [] }
});
feed.on('status', (s) => {
// Upstream connection state: "open", "closed", "connecting"
console.log(s.status);
});
feed.on('snapshot', (ticks) => {
// Bulk payload sent on connect with the last known value for every instrument
// you subscribed to. Useful to populate your UI immediately.
ticks.forEach(updateRow);
});
feed.on('tick', (tick) => {
// Streamed continuously as prices change.
updateRow(tick);
});
feed.on('error', (err) => {
// Connection error or server-side message.
console.error(err);
});
```
---
## 7. Using without the SDK (plain EventSource)
If you prefer native browser APIs:
```js
const url = new URL('https://mkt-ticker-data-production.up.railway.app/api/public/stream');
url.searchParams.set('token', 'YOUR_TOKEN');
url.searchParams.set('subs', '19:2101,19:2102,3:2,2:26000');
const es = new EventSource(url);
es.addEventListener('tick', (msg) => {
const tick = JSON.parse(msg.data);
console.log(tick.symbol, tick.ltp);
});
```
---
## 8. Framework examples
### React (hook)
```jsx
import { useEffect, useState } from 'react';
function useLiveTicker(subs, token) {
const [ticks, setTicks] = useState({});
useEffect(() => {
const feed = new VeloraFeed({
endpoint: 'https://mkt-ticker-data-production.up.railway.app',
token,
subs,
});
feed.on('snapshot', (list) => {
setTicks((cur) => ({ ...cur, ...Object.fromEntries(list.map(t => [t.key, t])) }));
});
feed.on('tick', (t) => setTicks((cur) => ({ ...cur, [t.key]: t })));
feed.start();
return () => feed.stop();
}, [JSON.stringify(subs), token]);
return ticks;
}
// usage:
const ticks = useLiveTicker([[19,2101],[2,26000]], 'YOUR_TOKEN');
return BTC: {ticks['19_2101']?.ltp}
;
```
### Vue 3
```vue
{{ t.symbol }}: {{ t.ltp }}
```
---
## 9. Rate limits & policies
| Rule | Limit |
|---|---|
| Max subscriptions per connection | **200** (default; can be raised on request) |
| Max concurrent connections per token | No hard cap; be sensible |
| Reconnect on drop | Automatic; client reconnects after network loss |
| Allowed segments | Configured per-token (we'll share your list) |
---
## 10. Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| `401 Unauthorized` | Missing/invalid token | Check the token string; no quotes/whitespace |
| `403 Forbidden` | Origin not whitelisted | Send us the exact origin shown in devtools Network tab |
| `429 Too Many Requests` | Over subscription cap | Reduce subs or ask for a higher limit |
| No ticks flowing, status "open" | Subscribed to segment not allowed for your token | Check the `hello` event's `denied` array |
| CORS errors in devtools | Browser blocks before hitting our server | Whitelist issue — contact us with your origin |
## 11. Browser compatibility
Works in all modern browsers (Chrome, Edge, Firefox, Safari). SSE is supported
natively; no polyfill needed. IE 11 is not supported.
---
## 12. Contact
- **Endpoint:** https://mkt-ticker-data-production.up.railway.app
- **Demo:** https://mkt-ticker-data-production.up.railway.app/demo.html
- **Issues / new origins / limit increases:** contact your account manager
Happy trading!