Skip to content

docs: README polish (badges, 45+ count, punctuation) #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mlaz-code merged 1 commit into from
Jul 13, 2026
Merged

docs: README polish (badges, 45+ count, punctuation) #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# @sharp-api/client

[![npm](https://img.shields.io/npm/v/%40sharp-api%2Fclient?color=06b6d4)](https://www.npmjs.com/package/@sharp-api/client)
[![license](https://img.shields.io/badge/license-MIT-06b6d4)](LICENSE)
[![docs](https://img.shields.io/badge/docs-docs.sharpapi.io-06b6d4)](https://docs.sharpapi.io)

Official TypeScript/JavaScript client for the [SharpAPI](https://sharpapi.io) real-time sports betting odds API.

Get pre-computed +EV opportunities, arbitrage detection, middles, and live odds from 20+ sportsbooks — with Pinnacle as the sharp reference.
Get pre-computed +EV opportunities, arbitrage detection, middles, and live odds from 45+ sportsbooks, with Pinnacle as the sharp reference.

## Install

Expand Down Expand Up @@ -66,7 +70,7 @@ stream.disconnect()

## WebSocket Streaming

Real-time push (~100ms vs 1-2s for REST polling). SSE delivers comparable latency — pick WS for bidirectional control (subscribe/unsubscribe, filter updates) or SSE for simpler one-way streaming behind firewalls:
Real-time push (~100ms vs 1-2s for REST polling). SSE delivers comparable latency: pick WS for bidirectional control (subscribe/unsubscribe, filter updates) or SSE for simpler one-way streaming behind firewalls:

```typescript
const stream = api.stream.oddsWs({
Expand Down