@apicity/thesportsdb 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,1512 @@
1
+ # @apicity/thesportsdb
2
+
3
+ [![npm](https://img.shields.io/npm/v/@apicity/thesportsdb?color=cb0000)](https://www.npmjs.com/package/@apicity/thesportsdb)
4
+ [![dependencies](https://img.shields.io/badge/dependencies-1-blue)](package.json)
5
+ [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue?logo=typescript&logoColor=white)](tsconfig.json)
6
+ [![docs](https://img.shields.io/badge/docs-thesportsdb.com-blue)](https://www.thesportsdb.com/docs_api_guide)
7
+
8
+ TheSportsDB V1 and V2 sports data API provider.
9
+
10
+ Runtime dependencies:
11
+
12
+ - `zod@^3.24.0` — request schemas attached to endpoint methods as `.schema`; response schemas exported
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ npm install @apicity/thesportsdb
18
+ # or
19
+ pnpm add @apicity/thesportsdb
20
+ ```
21
+
22
+ ## Quick Start
23
+
24
+ ```typescript
25
+ import { createTheSportsDB } from "@apicity/thesportsdb";
26
+
27
+ const thesportsdb = createTheSportsDB({ apiKey: process.env.THESPORTSDB_API_KEY });
28
+ ```
29
+
30
+ ## V2 Authentication
31
+
32
+ V1 calls default to TheSportsDB's free `123` key in the URL path when
33
+ `apiKey` is omitted. V2 is premium-only and sends the same `apiKey` in
34
+ the `X-API-KEY` header; V2 methods throw locally if no key is configured.
35
+
36
+ ```typescript
37
+ const thesportsdb = createTheSportsDB({
38
+ apiKey: process.env.THESPORTSDB_API_KEY!,
39
+ });
40
+
41
+ const teams = await thesportsdb.v2.search.team({
42
+ teamName: "Manchester United",
43
+ });
44
+ ```
45
+
46
+ For V1 premium calls, the same `apiKey` option is encoded into the
47
+ path segment instead of a header:
48
+
49
+ ```typescript
50
+ const premiumV1 = createTheSportsDB({
51
+ apiKey: process.env.THESPORTSDB_API_KEY!,
52
+ });
53
+
54
+ const broadcasts = await premiumV1.v1.eventstv({
55
+ channel: "Peacock_Premium",
56
+ });
57
+ ```
58
+
59
+ ## Operational Notes
60
+
61
+ All implemented TheSportsDB endpoints are read-only `GET` calls. The
62
+ provider does not expose mutating endpoints.
63
+
64
+ The implemented API surface has no pagination parameters. Upstream
65
+ responses use endpoint-specific wrapper arrays and documented result
66
+ limits; empty and no-result wrappers remain representable as `null` or
67
+ empty arrays.
68
+
69
+ Non-2xx responses throw `TheSportsDBError` with `status` and parsed
70
+ `body` where possible. Rate-limit responses keep their upstream `429`
71
+ status and body. V2 methods throw a local `401` before fetch when no
72
+ `apiKey` is configured for `X-API-KEY` authentication.
73
+
74
+ ## Search Examples
75
+
76
+ TheSportsDB V1 uses the free `123` key by default. Pass `apiKey` only
77
+ when you have a premium key.
78
+
79
+ ```typescript
80
+ import { createTheSportsDB } from "@apicity/thesportsdb";
81
+
82
+ const thesportsdb = createTheSportsDB();
83
+
84
+ const teams = await thesportsdb.v1.searchTeams({
85
+ team: "Arsenal",
86
+ });
87
+
88
+ const events = await thesportsdb.v1.searchEvents({
89
+ event: "Arsenal_vs_Chelsea",
90
+ season: "2016-2017",
91
+ date: "2015-04-26",
92
+ });
93
+
94
+ const filename = await thesportsdb.v1.searchFilename({
95
+ filename: "English_Premier_League_2015-04-26_Arsenal_vs_Chelsea",
96
+ });
97
+
98
+ const players = await thesportsdb.v1.searchPlayers({
99
+ player: "Danny Welbeck",
100
+ });
101
+
102
+ const venues = await thesportsdb.v1.searchVenues({
103
+ venue: "Wembley",
104
+ });
105
+ ```
106
+
107
+ No-result V1 searches preserve TheSportsDB's nullable wrapper arrays,
108
+ such as `{ teams: null }` or `{ player: null }`.
109
+
110
+ ## Player Lookup Examples
111
+
112
+ Player lookup, honours, former-team, milestone, contract, result, and
113
+ statistics routes use TheSportsDB's numeric player id.
114
+
115
+ ```typescript
116
+ import { createTheSportsDB } from "@apicity/thesportsdb";
117
+
118
+ const thesportsdb = createTheSportsDB({
119
+ apiKey: process.env.THESPORTSDB_API_KEY,
120
+ });
121
+
122
+ const player = await thesportsdb.v1.lookupplayer({ idPlayer: 34145937 });
123
+ const honours = await thesportsdb.v1.lookuphonours({ idPlayer: 34147178 });
124
+ const stats = await thesportsdb.v1.lookupplayerstats({ idPlayer: 34146304 });
125
+ ```
126
+
127
+ No-result responses preserve TheSportsDB's wrapper key with a `null`
128
+ value, for example `{ players: null }`.
129
+
130
+ V1 uses an API key in the URL path. The provider defaults to the public
131
+ free key `123`; pass `apiKey` to use your own key.
132
+ V2 uses the same `apiKey` option as an `X-API-KEY` header and is
133
+ available under `thesportsdb.v2`.
134
+
135
+ ```typescript
136
+ const league = await thesportsdb.v1.lookup.league({ idLeague: 4328 });
137
+ const table = await thesportsdb.v1.lookup.table({
138
+ idLeague: 4328,
139
+ season: "2020-2021",
140
+ });
141
+ const team = await thesportsdb.v1.lookup.team({ idTeam: 133604 });
142
+
143
+ const nextLeagueEvents = await thesportsdb.v2.schedule.next.league({
144
+ idLeague: 4328,
145
+ });
146
+ const liveSoccer = await thesportsdb.v2.livescore.bySport({
147
+ sport: "soccer",
148
+ });
149
+ ```
150
+
151
+ V2 is premium-only and sends the same `apiKey` as an `X-API-KEY`
152
+ header. V2 lookup method names mirror the path segments:
153
+
154
+ ```typescript
155
+ const player = await thesportsdb.v2.lookup.player({ idPlayer: 34172575 });
156
+ const lineup = await thesportsdb.v2.lookup.eventLineup({
157
+ idEvent: 1937584,
158
+ });
159
+ const highlights = await thesportsdb.v2.lookup.eventHighlights({
160
+ idEvent: 2044892,
161
+ });
162
+ ```
163
+
164
+ ## API Reference
165
+
166
+ 84 endpoints across 40 groups. Each method mirrors an upstream URL path.
167
+
168
+ ### all
169
+
170
+ <details>
171
+ <summary><code>GET</code> <b><code>thesportsdb.v2.all.countries</code></b></summary>
172
+
173
+ <code>GET https://www.thesportsdb.com/api/v2/json/all/countries</code>
174
+
175
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-all)
176
+
177
+ ```typescript
178
+ const res = await thesportsdb.v2.all.countries({ /* ... */ });
179
+ ```
180
+
181
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
182
+
183
+ </details>
184
+
185
+ <details>
186
+ <summary><code>GET</code> <b><code>thesportsdb.v2.all.leagues</code></b></summary>
187
+
188
+ <code>GET https://www.thesportsdb.com/api/v2/json/all/leagues</code>
189
+
190
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-all)
191
+
192
+ ```typescript
193
+ const res = await thesportsdb.v2.all.leagues({ /* ... */ });
194
+ ```
195
+
196
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
197
+
198
+ </details>
199
+
200
+ <details>
201
+ <summary><code>GET</code> <b><code>thesportsdb.v2.all.sports</code></b></summary>
202
+
203
+ <code>GET https://www.thesportsdb.com/api/v2/json/all/sports</code>
204
+
205
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-all)
206
+
207
+ ```typescript
208
+ const res = await thesportsdb.v2.all.sports({ /* ... */ });
209
+ ```
210
+
211
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
212
+
213
+ </details>
214
+
215
+ ### allCountries
216
+
217
+ <details>
218
+ <summary><code>GET</code> <b><code>thesportsdb.v1.allCountries</code></b></summary>
219
+
220
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/all_countries.php</code>
221
+
222
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getallcountries)
223
+
224
+ ```typescript
225
+ const res = await thesportsdb.v1.allCountries({ /* ... */ });
226
+ ```
227
+
228
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
229
+
230
+ </details>
231
+
232
+ ### allLeagues
233
+
234
+ <details>
235
+ <summary><code>GET</code> <b><code>thesportsdb.v1.allLeagues</code></b></summary>
236
+
237
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/all_leagues.php</code>
238
+
239
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-list)
240
+
241
+ ```typescript
242
+ const res = await thesportsdb.v1.allLeagues({ /* ... */ });
243
+ ```
244
+
245
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
246
+
247
+ </details>
248
+
249
+ ### allSports
250
+
251
+ <details>
252
+ <summary><code>GET</code> <b><code>thesportsdb.v1.allSports</code></b></summary>
253
+
254
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/all_sports.php</code>
255
+
256
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getallsports)
257
+
258
+ ```typescript
259
+ const res = await thesportsdb.v1.allSports({ /* ... */ });
260
+ ```
261
+
262
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
263
+
264
+ </details>
265
+
266
+ ### eventResults
267
+
268
+ <details>
269
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventResults</code></b></summary>
270
+
271
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventresults.php{query}</code>
272
+
273
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-lookup)
274
+
275
+ ```typescript
276
+ const res = await thesportsdb.v1.eventResults({ /* ... */ });
277
+ ```
278
+
279
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
280
+
281
+ </details>
282
+
283
+ ### eventsday
284
+
285
+ <details>
286
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventsday</code></b></summary>
287
+
288
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventsday.php{query}</code>
289
+
290
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-schedule)
291
+
292
+ ```typescript
293
+ const res = await thesportsdb.v1.eventsday({ /* ... */ });
294
+ ```
295
+
296
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
297
+
298
+ </details>
299
+
300
+ ### eventshighlights
301
+
302
+ <details>
303
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventshighlights</code></b></summary>
304
+
305
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventshighlights.php{query}</code>
306
+
307
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-video)
308
+
309
+ ```typescript
310
+ const res = await thesportsdb.v1.eventshighlights({ /* ... */ });
311
+ ```
312
+
313
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
314
+
315
+ </details>
316
+
317
+ ### eventslast
318
+
319
+ <details>
320
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventslast</code></b></summary>
321
+
322
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventslast.php{query}</code>
323
+
324
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-schedule)
325
+
326
+ ```typescript
327
+ const res = await thesportsdb.v1.eventslast({ /* ... */ });
328
+ ```
329
+
330
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
331
+
332
+ </details>
333
+
334
+ ### eventsnext
335
+
336
+ <details>
337
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventsnext</code></b></summary>
338
+
339
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventsnext.php{query}</code>
340
+
341
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-schedule)
342
+
343
+ ```typescript
344
+ const res = await thesportsdb.v1.eventsnext({ /* ... */ });
345
+ ```
346
+
347
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
348
+
349
+ </details>
350
+
351
+ ### eventsnextleague
352
+
353
+ <details>
354
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventsnextleague</code></b></summary>
355
+
356
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventsnextleague.php{query}</code>
357
+
358
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-schedule)
359
+
360
+ ```typescript
361
+ const res = await thesportsdb.v1.eventsnextleague({ /* ... */ });
362
+ ```
363
+
364
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
365
+
366
+ </details>
367
+
368
+ ### eventspastleague
369
+
370
+ <details>
371
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventspastleague</code></b></summary>
372
+
373
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventspastleague.php{query}</code>
374
+
375
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-schedule)
376
+
377
+ ```typescript
378
+ const res = await thesportsdb.v1.eventspastleague({ /* ... */ });
379
+ ```
380
+
381
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
382
+
383
+ </details>
384
+
385
+ ### eventsseason
386
+
387
+ <details>
388
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventsseason</code></b></summary>
389
+
390
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventsseason.php{query}</code>
391
+
392
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-schedule)
393
+
394
+ ```typescript
395
+ const res = await thesportsdb.v1.eventsseason({ /* ... */ });
396
+ ```
397
+
398
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
399
+
400
+ </details>
401
+
402
+ ### eventstv
403
+
404
+ <details>
405
+ <summary><code>GET</code> <b><code>thesportsdb.v1.eventstv</code></b></summary>
406
+
407
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/eventstv.php{query}</code>
408
+
409
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-schedule)
410
+
411
+ ```typescript
412
+ const res = await thesportsdb.v1.eventstv({ /* ... */ });
413
+ ```
414
+
415
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
416
+
417
+ </details>
418
+
419
+ ### filter
420
+
421
+ <details>
422
+ <summary><code>GET</code> <b><code>thesportsdb.v2.filter.tv.channel</code></b></summary>
423
+
424
+ <code>GET https://www.thesportsdb.com/api/v2/json/filter/tv/channel/{channel}</code>
425
+
426
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-filter)
427
+
428
+ ```typescript
429
+ const res = await thesportsdb.v2.filter.tv.channel({ /* ... */ });
430
+ ```
431
+
432
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
433
+
434
+ </details>
435
+
436
+ <details>
437
+ <summary><code>GET</code> <b><code>thesportsdb.v2.filter.tv.channelid</code></b></summary>
438
+
439
+ <code>GET https://www.thesportsdb.com/api/v2/json/filter/tv/channelid/{idChannel}</code>
440
+
441
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-filter)
442
+
443
+ ```typescript
444
+ const res = await thesportsdb.v2.filter.tv.channelid({ /* ... */ });
445
+ ```
446
+
447
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
448
+
449
+ </details>
450
+
451
+ <details>
452
+ <summary><code>GET</code> <b><code>thesportsdb.v2.filter.tv.country</code></b></summary>
453
+
454
+ <code>GET https://www.thesportsdb.com/api/v2/json/filter/tv/country/{country}</code>
455
+
456
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-filter)
457
+
458
+ ```typescript
459
+ const res = await thesportsdb.v2.filter.tv.country({ /* ... */ });
460
+ ```
461
+
462
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
463
+
464
+ </details>
465
+
466
+ <details>
467
+ <summary><code>GET</code> <b><code>thesportsdb.v2.filter.tv.day</code></b></summary>
468
+
469
+ <code>GET https://www.thesportsdb.com/api/v2/json/filter/tv/day/{date}</code>
470
+
471
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-filter)
472
+
473
+ ```typescript
474
+ const res = await thesportsdb.v2.filter.tv.day({ /* ... */ });
475
+ ```
476
+
477
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
478
+
479
+ </details>
480
+
481
+ <details>
482
+ <summary><code>GET</code> <b><code>thesportsdb.v2.filter.tv.sport</code></b></summary>
483
+
484
+ <code>GET https://www.thesportsdb.com/api/v2/json/filter/tv/sport/{sport}</code>
485
+
486
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-filter)
487
+
488
+ ```typescript
489
+ const res = await thesportsdb.v2.filter.tv.sport({ /* ... */ });
490
+ ```
491
+
492
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
493
+
494
+ </details>
495
+
496
+ ### list
497
+
498
+ <details>
499
+ <summary><code>GET</code> <b><code>thesportsdb.v2.list.players</code></b></summary>
500
+
501
+ <code>GET https://www.thesportsdb.com/api/v2/json/list/players/{idTeam}</code>
502
+
503
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-list)
504
+
505
+ ```typescript
506
+ const res = await thesportsdb.v2.list.players({ /* ... */ });
507
+ ```
508
+
509
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
510
+
511
+ </details>
512
+
513
+ <details>
514
+ <summary><code>GET</code> <b><code>thesportsdb.v2.list.seasonposters</code></b></summary>
515
+
516
+ <code>GET https://www.thesportsdb.com/api/v2/json/list/seasonposters/{idLeague}</code>
517
+
518
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-list)
519
+
520
+ ```typescript
521
+ const res = await thesportsdb.v2.list.seasonposters({ /* ... */ });
522
+ ```
523
+
524
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
525
+
526
+ </details>
527
+
528
+ <details>
529
+ <summary><code>GET</code> <b><code>thesportsdb.v2.list.seasons</code></b></summary>
530
+
531
+ <code>GET https://www.thesportsdb.com/api/v2/json/list/seasons/{idLeague}</code>
532
+
533
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-list)
534
+
535
+ ```typescript
536
+ const res = await thesportsdb.v2.list.seasons({ /* ... */ });
537
+ ```
538
+
539
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
540
+
541
+ </details>
542
+
543
+ <details>
544
+ <summary><code>GET</code> <b><code>thesportsdb.v2.list.teams</code></b></summary>
545
+
546
+ <code>GET https://www.thesportsdb.com/api/v2/json/list/teams/{idLeague}</code>
547
+
548
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-list)
549
+
550
+ ```typescript
551
+ const res = await thesportsdb.v2.list.teams({ /* ... */ });
552
+ ```
553
+
554
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
555
+
556
+ </details>
557
+
558
+ ### livescore
559
+
560
+ <details>
561
+ <summary><code>GET</code> <b><code>thesportsdb.v2.livescore.all</code></b></summary>
562
+
563
+ <code>GET https://www.thesportsdb.com/api/v2/json/livescore/all</code>
564
+
565
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-livescores)
566
+
567
+ ```typescript
568
+ const res = await thesportsdb.v2.livescore.all({ /* ... */ });
569
+ ```
570
+
571
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
572
+
573
+ </details>
574
+
575
+ <details>
576
+ <summary><code>GET</code> <b><code>thesportsdb.v2.livescore.byLeague</code></b></summary>
577
+
578
+ <code>GET https://www.thesportsdb.com/api/v2/json/livescore/{leagueId}</code>
579
+
580
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-livescores)
581
+
582
+ ```typescript
583
+ const res = await thesportsdb.v2.livescore.byLeague({ /* ... */ });
584
+ ```
585
+
586
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
587
+
588
+ </details>
589
+
590
+ <details>
591
+ <summary><code>GET</code> <b><code>thesportsdb.v2.livescore.bySport</code></b></summary>
592
+
593
+ <code>GET https://www.thesportsdb.com/api/v2/json/livescore/{sport}</code>
594
+
595
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-livescores)
596
+
597
+ ```typescript
598
+ const res = await thesportsdb.v2.livescore.bySport({ /* ... */ });
599
+ ```
600
+
601
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
602
+
603
+ </details>
604
+
605
+ ### lookup
606
+
607
+ <details>
608
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.event</code></b></summary>
609
+
610
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/event/{idEvent}</code>
611
+
612
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
613
+
614
+ ```typescript
615
+ const res = await thesportsdb.v2.lookup.event({ /* ... */ });
616
+ ```
617
+
618
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
619
+
620
+ </details>
621
+
622
+ <details>
623
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.eventHighlights</code></b></summary>
624
+
625
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/event_highlights/{idEvent}</code>
626
+
627
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
628
+
629
+ ```typescript
630
+ const res = await thesportsdb.v2.lookup.eventHighlights({ /* ... */ });
631
+ ```
632
+
633
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
634
+
635
+ </details>
636
+
637
+ <details>
638
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.eventLineup</code></b></summary>
639
+
640
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/event_lineup/{idEvent}</code>
641
+
642
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
643
+
644
+ ```typescript
645
+ const res = await thesportsdb.v2.lookup.eventLineup({ /* ... */ });
646
+ ```
647
+
648
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
649
+
650
+ </details>
651
+
652
+ <details>
653
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.eventResults</code></b></summary>
654
+
655
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/event_results/{idEvent}</code>
656
+
657
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
658
+
659
+ ```typescript
660
+ const res = await thesportsdb.v2.lookup.eventResults({ /* ... */ });
661
+ ```
662
+
663
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
664
+
665
+ </details>
666
+
667
+ <details>
668
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.eventStats</code></b></summary>
669
+
670
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/event_stats/{idEvent}</code>
671
+
672
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
673
+
674
+ ```typescript
675
+ const res = await thesportsdb.v2.lookup.eventStats({ /* ... */ });
676
+ ```
677
+
678
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
679
+
680
+ </details>
681
+
682
+ <details>
683
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.eventTimeline</code></b></summary>
684
+
685
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/event_timeline/{idEvent}</code>
686
+
687
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
688
+
689
+ ```typescript
690
+ const res = await thesportsdb.v2.lookup.eventTimeline({ /* ... */ });
691
+ ```
692
+
693
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
694
+
695
+ </details>
696
+
697
+ <details>
698
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.eventTv</code></b></summary>
699
+
700
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/event_tv/{idEvent}</code>
701
+
702
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
703
+
704
+ ```typescript
705
+ const res = await thesportsdb.v2.lookup.eventTv({ /* ... */ });
706
+ ```
707
+
708
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
709
+
710
+ </details>
711
+
712
+ <details>
713
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.league</code></b></summary>
714
+
715
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/league/{idLeague}</code>
716
+
717
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
718
+
719
+ ```typescript
720
+ const res = await thesportsdb.v2.lookup.league({ /* ... */ });
721
+ ```
722
+
723
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
724
+
725
+ </details>
726
+
727
+ <details>
728
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.player</code></b></summary>
729
+
730
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/player/{idPlayer}</code>
731
+
732
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
733
+
734
+ ```typescript
735
+ const res = await thesportsdb.v2.lookup.player({ /* ... */ });
736
+ ```
737
+
738
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
739
+
740
+ </details>
741
+
742
+ <details>
743
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.playerContracts</code></b></summary>
744
+
745
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/player_contracts/{idPlayer}</code>
746
+
747
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
748
+
749
+ ```typescript
750
+ const res = await thesportsdb.v2.lookup.playerContracts({ /* ... */ });
751
+ ```
752
+
753
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
754
+
755
+ </details>
756
+
757
+ <details>
758
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.playerHonours</code></b></summary>
759
+
760
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/player_honours/{idPlayer}</code>
761
+
762
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
763
+
764
+ ```typescript
765
+ const res = await thesportsdb.v2.lookup.playerHonours({ /* ... */ });
766
+ ```
767
+
768
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
769
+
770
+ </details>
771
+
772
+ <details>
773
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.playerMilestones</code></b></summary>
774
+
775
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/player_milestones/{idPlayer}</code>
776
+
777
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
778
+
779
+ ```typescript
780
+ const res = await thesportsdb.v2.lookup.playerMilestones({ /* ... */ });
781
+ ```
782
+
783
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
784
+
785
+ </details>
786
+
787
+ <details>
788
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.playerResults</code></b></summary>
789
+
790
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/player_results/{idPlayer}</code>
791
+
792
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
793
+
794
+ ```typescript
795
+ const res = await thesportsdb.v2.lookup.playerResults({ /* ... */ });
796
+ ```
797
+
798
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
799
+
800
+ </details>
801
+
802
+ <details>
803
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.playerStats</code></b></summary>
804
+
805
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/player_stats/{idPlayer}</code>
806
+
807
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
808
+
809
+ ```typescript
810
+ const res = await thesportsdb.v2.lookup.playerStats({ /* ... */ });
811
+ ```
812
+
813
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
814
+
815
+ </details>
816
+
817
+ <details>
818
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.playerTeams</code></b></summary>
819
+
820
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/player_teams/{idPlayer}</code>
821
+
822
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
823
+
824
+ ```typescript
825
+ const res = await thesportsdb.v2.lookup.playerTeams({ /* ... */ });
826
+ ```
827
+
828
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
829
+
830
+ </details>
831
+
832
+ <details>
833
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.team</code></b></summary>
834
+
835
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/team/{idTeam}</code>
836
+
837
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
838
+
839
+ ```typescript
840
+ const res = await thesportsdb.v2.lookup.team({ /* ... */ });
841
+ ```
842
+
843
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
844
+
845
+ </details>
846
+
847
+ <details>
848
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.teamEquipment</code></b></summary>
849
+
850
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/team_equipment/{idTeam}</code>
851
+
852
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
853
+
854
+ ```typescript
855
+ const res = await thesportsdb.v2.lookup.teamEquipment({ /* ... */ });
856
+ ```
857
+
858
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
859
+
860
+ </details>
861
+
862
+ <details>
863
+ <summary><code>GET</code> <b><code>thesportsdb.v2.lookup.venue</code></b></summary>
864
+
865
+ <code>GET https://www.thesportsdb.com/api/v2/json/lookup/venue/{idVenue}</code>
866
+
867
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-lookup)
868
+
869
+ ```typescript
870
+ const res = await thesportsdb.v2.lookup.venue({ /* ... */ });
871
+ ```
872
+
873
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
874
+
875
+ </details>
876
+
877
+ <details>
878
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookup.equipment</code></b></summary>
879
+
880
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupequipment.php{query}</code>
881
+
882
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide)
883
+
884
+ ```typescript
885
+ const res = await thesportsdb.v1.lookup.equipment({ /* ... */ });
886
+ ```
887
+
888
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
889
+
890
+ </details>
891
+
892
+ <details>
893
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookup.league</code></b></summary>
894
+
895
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupleague.php{query}</code>
896
+
897
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide)
898
+
899
+ ```typescript
900
+ const res = await thesportsdb.v1.lookup.league({ /* ... */ });
901
+ ```
902
+
903
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
904
+
905
+ </details>
906
+
907
+ <details>
908
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookup.table</code></b></summary>
909
+
910
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookuptable.php{query}</code>
911
+
912
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide)
913
+
914
+ ```typescript
915
+ const res = await thesportsdb.v1.lookup.table({ /* ... */ });
916
+ ```
917
+
918
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
919
+
920
+ </details>
921
+
922
+ <details>
923
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookup.team</code></b></summary>
924
+
925
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupteam.php{query}</code>
926
+
927
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide)
928
+
929
+ ```typescript
930
+ const res = await thesportsdb.v1.lookup.team({ /* ... */ });
931
+ ```
932
+
933
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
934
+
935
+ </details>
936
+
937
+ <details>
938
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookup.venue</code></b></summary>
939
+
940
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupvenue.php{query}</code>
941
+
942
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide)
943
+
944
+ ```typescript
945
+ const res = await thesportsdb.v1.lookup.venue({ /* ... */ });
946
+ ```
947
+
948
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
949
+
950
+ </details>
951
+
952
+ ### lookupAllPlayers
953
+
954
+ <details>
955
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupAllPlayers</code></b></summary>
956
+
957
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookup_all_players.php{query}</code>
958
+
959
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-list)
960
+
961
+ ```typescript
962
+ const res = await thesportsdb.v1.lookupAllPlayers({ /* ... */ });
963
+ ```
964
+
965
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
966
+
967
+ </details>
968
+
969
+ ### lookupcontracts
970
+
971
+ <details>
972
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupcontracts</code></b></summary>
973
+
974
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupcontracts.php?id={idPlayer}</code>
975
+
976
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getcontractsbyplayerid)
977
+
978
+ ```typescript
979
+ const res = await thesportsdb.v1.lookupcontracts({ /* ... */ });
980
+ ```
981
+
982
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
983
+
984
+ </details>
985
+
986
+ ### lookupEvent
987
+
988
+ <details>
989
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupEvent</code></b></summary>
990
+
991
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupevent.php{query}</code>
992
+
993
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-lookup)
994
+
995
+ ```typescript
996
+ const res = await thesportsdb.v1.lookupEvent({ /* ... */ });
997
+ ```
998
+
999
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1000
+
1001
+ </details>
1002
+
1003
+ ### lookupEventStats
1004
+
1005
+ <details>
1006
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupEventStats</code></b></summary>
1007
+
1008
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupeventstats.php{query}</code>
1009
+
1010
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-lookup)
1011
+
1012
+ ```typescript
1013
+ const res = await thesportsdb.v1.lookupEventStats({ /* ... */ });
1014
+ ```
1015
+
1016
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1017
+
1018
+ </details>
1019
+
1020
+ ### lookupformerteams
1021
+
1022
+ <details>
1023
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupformerteams</code></b></summary>
1024
+
1025
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupformerteams.php?id={idPlayer}</code>
1026
+
1027
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getformerteamsbyplayerid)
1028
+
1029
+ ```typescript
1030
+ const res = await thesportsdb.v1.lookupformerteams({ /* ... */ });
1031
+ ```
1032
+
1033
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1034
+
1035
+ </details>
1036
+
1037
+ ### lookuphonours
1038
+
1039
+ <details>
1040
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookuphonours</code></b></summary>
1041
+
1042
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookuphonours.php?id={idPlayer}</code>
1043
+
1044
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/gethonourbyid)
1045
+
1046
+ ```typescript
1047
+ const res = await thesportsdb.v1.lookuphonours({ /* ... */ });
1048
+ ```
1049
+
1050
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1051
+
1052
+ </details>
1053
+
1054
+ ### lookupLineup
1055
+
1056
+ <details>
1057
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupLineup</code></b></summary>
1058
+
1059
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookuplineup.php{query}</code>
1060
+
1061
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-lookup)
1062
+
1063
+ ```typescript
1064
+ const res = await thesportsdb.v1.lookupLineup({ /* ... */ });
1065
+ ```
1066
+
1067
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1068
+
1069
+ </details>
1070
+
1071
+ ### lookupmilestones
1072
+
1073
+ <details>
1074
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupmilestones</code></b></summary>
1075
+
1076
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupmilestones.php?id={idPlayer}</code>
1077
+
1078
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getmilestonesbyplayerid)
1079
+
1080
+ ```typescript
1081
+ const res = await thesportsdb.v1.lookupmilestones({ /* ... */ });
1082
+ ```
1083
+
1084
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1085
+
1086
+ </details>
1087
+
1088
+ ### lookupplayer
1089
+
1090
+ <details>
1091
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupplayer</code></b></summary>
1092
+
1093
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupplayer.php?id={idPlayer}</code>
1094
+
1095
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getplayerbyid)
1096
+
1097
+ ```typescript
1098
+ const res = await thesportsdb.v1.lookupplayer({ /* ... */ });
1099
+ ```
1100
+
1101
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1102
+
1103
+ </details>
1104
+
1105
+ ### lookupplayerstats
1106
+
1107
+ <details>
1108
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupplayerstats</code></b></summary>
1109
+
1110
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookupplayerstats.php?id={idPlayer}</code>
1111
+
1112
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide)
1113
+
1114
+ ```typescript
1115
+ const res = await thesportsdb.v1.lookupplayerstats({ /* ... */ });
1116
+ ```
1117
+
1118
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1119
+
1120
+ </details>
1121
+
1122
+ ### lookupTimeline
1123
+
1124
+ <details>
1125
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupTimeline</code></b></summary>
1126
+
1127
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookuptimeline.php{query}</code>
1128
+
1129
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-lookup)
1130
+
1131
+ ```typescript
1132
+ const res = await thesportsdb.v1.lookupTimeline({ /* ... */ });
1133
+ ```
1134
+
1135
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1136
+
1137
+ </details>
1138
+
1139
+ ### lookupTv
1140
+
1141
+ <details>
1142
+ <summary><code>GET</code> <b><code>thesportsdb.v1.lookupTv</code></b></summary>
1143
+
1144
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/lookuptv.php{query}</code>
1145
+
1146
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-lookup)
1147
+
1148
+ ```typescript
1149
+ const res = await thesportsdb.v1.lookupTv({ /* ... */ });
1150
+ ```
1151
+
1152
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1153
+
1154
+ </details>
1155
+
1156
+ ### playerresults
1157
+
1158
+ <details>
1159
+ <summary><code>GET</code> <b><code>thesportsdb.v1.playerresults</code></b></summary>
1160
+
1161
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/playerresults.php?id={idPlayer}</code>
1162
+
1163
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide)
1164
+
1165
+ ```typescript
1166
+ const res = await thesportsdb.v1.playerresults({ /* ... */ });
1167
+ ```
1168
+
1169
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1170
+
1171
+ </details>
1172
+
1173
+ ### schedule
1174
+
1175
+ <details>
1176
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.full.team</code></b></summary>
1177
+
1178
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/full/team/{idTeam}</code>
1179
+
1180
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1181
+
1182
+ ```typescript
1183
+ const res = await thesportsdb.v2.schedule.full.team({ /* ... */ });
1184
+ ```
1185
+
1186
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1187
+
1188
+ </details>
1189
+
1190
+ <details>
1191
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.league</code></b></summary>
1192
+
1193
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/league/{idLeague}/{season}</code>
1194
+
1195
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1196
+
1197
+ ```typescript
1198
+ const res = await thesportsdb.v2.schedule.league({ /* ... */ });
1199
+ ```
1200
+
1201
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1202
+
1203
+ </details>
1204
+
1205
+ <details>
1206
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.next.league</code></b></summary>
1207
+
1208
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/next/league/{idLeague}</code>
1209
+
1210
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1211
+
1212
+ ```typescript
1213
+ const res = await thesportsdb.v2.schedule.next.league({ /* ... */ });
1214
+ ```
1215
+
1216
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1217
+
1218
+ </details>
1219
+
1220
+ <details>
1221
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.next.team</code></b></summary>
1222
+
1223
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/next/team/{idTeam}</code>
1224
+
1225
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1226
+
1227
+ ```typescript
1228
+ const res = await thesportsdb.v2.schedule.next.team({ /* ... */ });
1229
+ ```
1230
+
1231
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1232
+
1233
+ </details>
1234
+
1235
+ <details>
1236
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.next.venue</code></b></summary>
1237
+
1238
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/next/venue/{idVenue}</code>
1239
+
1240
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1241
+
1242
+ ```typescript
1243
+ const res = await thesportsdb.v2.schedule.next.venue({ /* ... */ });
1244
+ ```
1245
+
1246
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1247
+
1248
+ </details>
1249
+
1250
+ <details>
1251
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.previous.league</code></b></summary>
1252
+
1253
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/previous/league/{idLeague}</code>
1254
+
1255
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1256
+
1257
+ ```typescript
1258
+ const res = await thesportsdb.v2.schedule.previous.league({ /* ... */ });
1259
+ ```
1260
+
1261
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1262
+
1263
+ </details>
1264
+
1265
+ <details>
1266
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.previous.team</code></b></summary>
1267
+
1268
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/previous/team/{idTeam}</code>
1269
+
1270
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1271
+
1272
+ ```typescript
1273
+ const res = await thesportsdb.v2.schedule.previous.team({ /* ... */ });
1274
+ ```
1275
+
1276
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1277
+
1278
+ </details>
1279
+
1280
+ <details>
1281
+ <summary><code>GET</code> <b><code>thesportsdb.v2.schedule.previous.venue</code></b></summary>
1282
+
1283
+ <code>GET https://www.thesportsdb.com/api/v2/json/schedule/previous/venue/{idVenue}</code>
1284
+
1285
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-schedule)
1286
+
1287
+ ```typescript
1288
+ const res = await thesportsdb.v2.schedule.previous.venue({ /* ... */ });
1289
+ ```
1290
+
1291
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1292
+
1293
+ </details>
1294
+
1295
+ ### search
1296
+
1297
+ <details>
1298
+ <summary><code>GET</code> <b><code>thesportsdb.v2.search.event</code></b></summary>
1299
+
1300
+ <code>GET https://www.thesportsdb.com/api/v2/json/search/event/{eventName}</code>
1301
+
1302
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-search)
1303
+
1304
+ ```typescript
1305
+ const res = await thesportsdb.v2.search.event({ /* ... */ });
1306
+ ```
1307
+
1308
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1309
+
1310
+ </details>
1311
+
1312
+ <details>
1313
+ <summary><code>GET</code> <b><code>thesportsdb.v2.search.league</code></b></summary>
1314
+
1315
+ <code>GET https://www.thesportsdb.com/api/v2/json/search/league/{leagueName}</code>
1316
+
1317
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-search)
1318
+
1319
+ ```typescript
1320
+ const res = await thesportsdb.v2.search.league({ /* ... */ });
1321
+ ```
1322
+
1323
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1324
+
1325
+ </details>
1326
+
1327
+ <details>
1328
+ <summary><code>GET</code> <b><code>thesportsdb.v2.search.player</code></b></summary>
1329
+
1330
+ <code>GET https://www.thesportsdb.com/api/v2/json/search/player/{playerName}</code>
1331
+
1332
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-search)
1333
+
1334
+ ```typescript
1335
+ const res = await thesportsdb.v2.search.player({ /* ... */ });
1336
+ ```
1337
+
1338
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1339
+
1340
+ </details>
1341
+
1342
+ <details>
1343
+ <summary><code>GET</code> <b><code>thesportsdb.v2.search.team</code></b></summary>
1344
+
1345
+ <code>GET https://www.thesportsdb.com/api/v2/json/search/team/{teamName}</code>
1346
+
1347
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-search)
1348
+
1349
+ ```typescript
1350
+ const res = await thesportsdb.v2.search.team({ /* ... */ });
1351
+ ```
1352
+
1353
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1354
+
1355
+ </details>
1356
+
1357
+ <details>
1358
+ <summary><code>GET</code> <b><code>thesportsdb.v2.search.venue</code></b></summary>
1359
+
1360
+ <code>GET https://www.thesportsdb.com/api/v2/json/search/venue/{venueName}</code>
1361
+
1362
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v2-search)
1363
+
1364
+ ```typescript
1365
+ const res = await thesportsdb.v2.search.venue({ /* ... */ });
1366
+ ```
1367
+
1368
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1369
+
1370
+ </details>
1371
+
1372
+ ### searchAllLeagues
1373
+
1374
+ <details>
1375
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchAllLeagues</code></b></summary>
1376
+
1377
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/search_all_leagues.php{query}</code>
1378
+
1379
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-list)
1380
+
1381
+ ```typescript
1382
+ const res = await thesportsdb.v1.searchAllLeagues({ /* ... */ });
1383
+ ```
1384
+
1385
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1386
+
1387
+ </details>
1388
+
1389
+ ### searchAllSeasons
1390
+
1391
+ <details>
1392
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchAllSeasons</code></b></summary>
1393
+
1394
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/search_all_seasons.php{query}</code>
1395
+
1396
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-list)
1397
+
1398
+ ```typescript
1399
+ const res = await thesportsdb.v1.searchAllSeasons({ /* ... */ });
1400
+ ```
1401
+
1402
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1403
+
1404
+ </details>
1405
+
1406
+ ### searchAllTeams
1407
+
1408
+ <details>
1409
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchAllTeams</code></b></summary>
1410
+
1411
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/search_all_teams.php{query}</code>
1412
+
1413
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-list)
1414
+
1415
+ ```typescript
1416
+ const res = await thesportsdb.v1.searchAllTeams({ /* ... */ });
1417
+ ```
1418
+
1419
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1420
+
1421
+ </details>
1422
+
1423
+ ### searchEvents
1424
+
1425
+ <details>
1426
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchEvents</code></b></summary>
1427
+
1428
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/searchevents.php{query}</code>
1429
+
1430
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-search)
1431
+
1432
+ ```typescript
1433
+ const res = await thesportsdb.v1.searchEvents({ /* ... */ });
1434
+ ```
1435
+
1436
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1437
+
1438
+ </details>
1439
+
1440
+ ### searchFilename
1441
+
1442
+ <details>
1443
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchFilename</code></b></summary>
1444
+
1445
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/searchfilename.php{query}</code>
1446
+
1447
+ [Upstream docs ↗](https://www.thesportsdb.com/docs_api_guide#v1-search)
1448
+
1449
+ ```typescript
1450
+ const res = await thesportsdb.v1.searchFilename({ /* ... */ });
1451
+ ```
1452
+
1453
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1454
+
1455
+ </details>
1456
+
1457
+ ### searchPlayers
1458
+
1459
+ <details>
1460
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchPlayers</code></b></summary>
1461
+
1462
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/searchplayers.php{query}</code>
1463
+
1464
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getplayerbyname)
1465
+
1466
+ ```typescript
1467
+ const res = await thesportsdb.v1.searchPlayers({ /* ... */ });
1468
+ ```
1469
+
1470
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1471
+
1472
+ </details>
1473
+
1474
+ ### searchTeams
1475
+
1476
+ <details>
1477
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchTeams</code></b></summary>
1478
+
1479
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/searchteams.php{query}</code>
1480
+
1481
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getteambyname)
1482
+
1483
+ ```typescript
1484
+ const res = await thesportsdb.v1.searchTeams({ /* ... */ });
1485
+ ```
1486
+
1487
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1488
+
1489
+ </details>
1490
+
1491
+ ### searchVenues
1492
+
1493
+ <details>
1494
+ <summary><code>GET</code> <b><code>thesportsdb.v1.searchVenues</code></b></summary>
1495
+
1496
+ <code>GET https://www.thesportsdb.com/api/v1/json/{apiKey}/searchvenues.php{query}</code>
1497
+
1498
+ [Upstream docs ↗](https://thedatadb.readme.io/reference/getvenuebyname)
1499
+
1500
+ ```typescript
1501
+ const res = await thesportsdb.v1.searchVenues({ /* ... */ });
1502
+ ```
1503
+
1504
+ Source: [`packages/provider/thesportsdb/src/thesportsdb.ts`](src/thesportsdb.ts)
1505
+
1506
+ </details>
1507
+
1508
+ Part of the [apicity](https://github.com/justintanner/apicity) monorepo.
1509
+
1510
+ ## License
1511
+
1512
+ MIT — see [LICENSE](LICENSE).