scoreClientSocket

Authentication

Every request — REST or socket — needs a valid, unexpired agent key. Ask the platform owner for one; each key can optionally be locked to specific caller IPs.

How to send it

Failure responses

Rejection body shape

{ "success": false, "data": null, "message": "...", "status": 401 }

REST API

All routes are prefixed with /api. Every route below shares the auth rules above, a 5 req/s per-IP rate limit, and open CORS unless the deployment restricts it.

Scorecard & iframe

{
  "EventID": 12345,
  "scoreUrl": "https://.../scoreboard?id=12345&color=000000",
  "streamingUrl": "https://..."
}

Operational

Monitoring endpoints — connection counts, daily stats, instance lifecycle. Not needed for a typical score integration.

Real-time socket

A SignalR hub at /clientScore pushes score updates the moment they change — no polling needed on your side.

Connect

const connection = new signalR.HubConnectionBuilder()
  .withUrl(`wss://<host>/clientScore?key=${AGENT_KEY}`)
  .withAutomaticReconnect()
  .build();

connection.on('Score', (fullScore) => { /* §Score payloads */ });
connection.on('ShortScore', (shortScore) => { /* §Score payloads */ });

await connection.start();
connection.invoke('getscore', '30123456');
connection.invoke('getShortScore', '30123456');

Client → server methods

Server → client events

Heartbeat & reconnection

Use .withAutomaticReconnect(). Subscriptions are per-connection — on reconnect, re-issue getscore/getShortScore for every event you still care about. There's no explicit "connected" event; a resolved connection.start() is your signal.

Score payloads

scoredata (the Score event) and shortscoredata (ShortScore) are relayed byte-for-byte from the upstream provider.

eventTypeId (etid / eti) → sport

Score event — base fields

sc.hm / sc.aw — per side

ShortScore event — fields

No key aliasing here — these are the actual wire names.

Per sport

Soccer and tennis short scores are a summarized view of the same Score payload. Cricket short scores come from an independent feed whose messages already arrive pre-shaped this way — which is why currBatting* is only ever populated there.

Sample payloads

Soccer — Score

{
  "etid": 1, "eid": 30123456, "st": "IN_PLAY", "ms": "1st Half", "te": 1523, "ert": 1523,
  "fte": { "h": 0, "m": 25, "s": 23 },
  "sc": {
    "hm": { "na": "Team A", "sc": "1", "hts": "0", "ftc": "0", "nyfc": 2, "nfco": 3 },
    "aw": { "na": "Team B", "sc": "0", "hts": "0", "ftc": "0" }
  }
}

Soccer — ShortScore

{ "eti": 1, "eid": "30123456", "en": "Team A v Team B", "te1n": "Team A", "te2n": "Team B", "t1s": "1", "t2s": "0", "pt": 1523 }

Tennis — Score

{
  "etid": 2, "eid": 30234567, "cset": 2, "hs": true,
  "sc": {
    "hm": { "na": "Player A", "sc": "30", "games": "3", "sets": "1", "isrv": true, "gsq": ["15-0","15-15","30-15"] },
    "aw": { "na": "Player B", "sc": "15", "games": "2", "sets": "0", "isrv": false }
  }
}

Tennis — ShortScore

{ "eti": 2, "eid": "30234567", "en": "Player A v Player B", "te1n": "Player A", "te2n": "Player B", "t1s": "3", "t2s": "2", "pt": 2, "t1set": "1", "t2set": "0", "t1p": "30", "t2p": "15" }

Cricket — ShortScore (values illustrative — exact shape is whatever the feed sends)

{ "eti": 4, "eid": "30345678", "en": "Team A v Team B", "te1n": "Team A", "te2n": "Team B", "t1s": "156/4 (18.2)", "t2s": "", "currBatting": "Team A", "currBattingTeamScore": "156/4" }

No Score event for cricket — see the callout above.

Quick-start checklist

1. Get an agent key — and if you need IP restriction, share the IPs your backend calls from.
2. REST: send X-App: <key> (or ?key=) on every /api/* call.
3. Socket: connect to wss://<host>/clientScore?key=<key>.
4. Call getscore and/or getShortScore for each event you want.
5. Re-call getupdateScore at least every ~60–90s per event to keep it active.
6. Handle Score/ShortScore — remember cricket only ever sends ShortScore.
7. On reconnect, re-subscribe — the server doesn't remember your subscriptions across a dropped connection.