0.1.0 • Published 10 months ago

sportmonks-typescript-sdk v0.1.0

Weekly downloads
-
License
Unlicense
Repository
github
Last release
10 months ago

sportmonks-typescript-sdk@0.1.0

Surpass the competition with superior sports data

Installing

npm

npm install sportmonks-typescript-sdk --save

yarn

yarn add sportmonks-typescript-sdk

Important note: this library can be used in both the client-side or server-side, but using it in client-side browser code is not recommended as you would expose security credentials.

Getting Started

import { Sportmonks } from "sportmonks-typescript-sdk";

const sportmonks = new Sportmonks({
  // Defining the base path is optional and defaults to https://api.sportmonks.com
  // basePath: "https://api.sportmonks.com",
  version: "v3",
  sport: "football",
  apiKey: "API_KEY",
});

const allResponse = await sportmonks.cities.all({});

console.log(allResponse);

Documentation for API Endpoints

All URIs are relative to https://api.sportmonks.com

ClassMethodHTTP requestDescription
CitiesApiallGET /{version}/core/citiesAll
CitiesApigetByIdGET /{version}/core/cities/{cityId}By ID
CitiesApisearchGET /{version}/core/cities/search/{name}Search
ContinentsApiallGET /{version}/core/continentsAll
ContinentsApigetByIdGET /{version}/core/continents/{continentId}By ID
CountriesApiallGET /{version}/core/countriesAll
CountriesApigetByIdGET /{version}/core/countries/{countryId}By ID
CountriesApisearchGET /{version}/core/countries/search/{name}Search
MyApienrichmentsGET /{version}/my/enrichmentsAll
MyApileaguesGET /{version}/my/leaguesAll
MyApiresourcesGET /{version}/my/resourcesAll
OddsApibookmakerByIdGET /{version}/odds/bookmakers/{bookmakerId}By ID
OddsApibookmakersAllGET /{version}/odds/bookmakersAll
OddsApibookmakersByFixtureIdGET /{version}/odds/bookmakers/fixtures/{fixtureId}By Fixture ID
OddsApibookmakersMappingByFixtureIdGET /{version}/odds/bookmakers/fixtures/{fixtureId}/mappingMapping by Fixture ID
OddsApibookmakersSearchGET /{version}/odds/bookmakers/search/{name}Search
OddsApifixturesUpcomingByMarketIdGET /{version}/{sport}/fixtures/upcoming/markets/{marketId}Upcoming Fixtures by Market ID
OddsApimarketByIdGET /{version}/odds/markets/{marketId}By ID
OddsApimarketsAllGET /{version}/odds/marketsAll
OddsApimarketsSearchGET /{version}/odds/markets/search/{name}Search
RegionsApiallGET /{version}/core/regionsAll
RegionsApigetByIdGET /{version}/core/regions/{regionId}By ID
RegionsApisearchGET /{version}/core/regions/search/{name}Search
SportApicoachByIdGET /{version}/{sport}/coaches/{coachId}By ID
SportApicoachesAllGET /{version}/{sport}/coachesAll
SportApicoachesByCountryIdGET /{version}/{sport}/coaches/countries/{countryId}By Country ID
SportApicoachesLatestGET /{version}/{sport}/coaches/latestLast updated
SportApicoachesSearchGET /{version}/{sport}/coaches/search/{name}Search
SportApicommentariesAllGET /{version}/{sport}/commentariesAll
SportApicommentariesByFixtureIdGET /{version}/{sport}/commentaries/fixtures/{fixtureId}By Fixture ID
SportApifixtureByDateRangeForTeamGET /{version}/{sport}/fixtures/between/{startDate}/{endDate}/{teamId}By Date Range for Team
SportApifixtureByIdGET /{version}/{sport}/fixtures/{fixtureId}Fixture ID
SportApifixturesAllGET /{version}/{sport}/fixturesAll
SportApifixturesByDateGET /{version}/{sport}/fixtures/date/{date}By Date
SportApifixturesByDateRangeGET /{version}/{sport}/fixtures/between/{startDate}/{endDate}By Date Range
SportApifixturesByIdsGET /{version}/{sport}/fixtures/multi/{fixtureIds}By IDs
SportApifixturesHeadToHeadGET /{version}/{sport}/fixtures/head-to-head/{firstTeam}/{secondTeam}Head to Head
SportApifixturesLatestGET /{version}/{sport}/fixtures/latestLast Updated
SportApifixturesSearchGET /{version}/{sport}/fixtures/search/{name}Search
SportApileagueByIdGET /{version}/{sport}/leagues/{leagueId}By ID
SportApileagueEnrichmentsGET /{version}/{sport}/leagues/{leagueId}/includesEnrichments
SportApileagueShirtsGET /{version}/{sport}/leagues/{leagueId}/jerseysShirts By League ID
SportApileaguesAllGET /{version}/{sport}/leaguesAll
SportApileaguesByCountryIdGET /{version}/{sport}/leagues/countries/{countryId}By Country ID
SportApileaguesByDateGET /{version}/{sport}/leagues/date/{date}By Date
SportApileaguesByTeamIdGET /{version}/{sport}/teams/{teamId}/leaguesLeagues By Team ID
SportApileaguesCurrentByTeamIdGET /{version}/{sport}/teams/{teamId}/leagues/currentCurrent Leagues By Team ID
SportApileaguesLiveGET /{version}/{sport}/leagues/liveLive
SportApileaguesSearchGET /{version}/{sport}/leagues/search/{name}Search
SportApilivescoresAllGET /{version}/{sport}/livescoresAll
SportApilivescoresAllInPlayGET /{version}/{sport}/livescores/inplayAll In-play
SportApilivescoresLatestGET /{version}/{sport}/livescores/latestLast Updated In-play
SportApinewsAllPostMatchGET /{version}/{sport}/news/post-matchAll Post Match
SportApinewsAllPreMatchGET /{version}/{sport}/news/pre-matchAll Pre-match
SportApinewsPostMatchBySeasonIdGET /{version}/{sport}/news/post-match/seasons/{seasonId}Post Match by Season ID
SportApinewsPreMatchBySeasonIdGET /{version}/{sport}/news/pre-match/seasons/{seasonId}Pre-match By Season ID
SportApinewsUpcomingPostMatchGET /{version}/{sport}/news/post-match/upcomingUpcoming Post Match
SportApinewsUpcomingPreMatchGET /{version}/{sport}/news/pre-match/upcomingUpcoming Pre-match
SportApioddsAllInPlayGET /{version}/{sport}/odds/inplayAll In-play
SportApioddsAllPreMatchGET /{version}/{sport}/odds/pre-matchAll Pre-match
SportApioddsInPlayByFixtureAndBookmakerIdGET /{version}/{sport}/odds/inplay/fixtures/{fixtureId}/bookmakers/{bookmakerId}In-play by Fixture and Bookmaker ID
SportApioddsInPlayByFixtureAndMarketIdGET /{version}/{sport}/odds/inplay/fixtures/{fixtureId}/markets/{marketId}In-play by Fixture and Market ID
SportApioddsInPlayByFixtureIdGET /{version}/{sport}/odds/inplay/fixtures/{fixtureId}In-play by Fixture ID
SportApioddsLatestInPlayGET /{version}/{sport}/odds/inplay/latestLatest In-play
SportApioddsLatestPreMatchGET /{version}/{sport}/odds/pre-match/latestLast Updated Pre-match
SportApioddsPreMatchByFixtureAndBookmakerIdGET /{version}/{sport}/odds/pre-match/fixtures/{fixtureId}/bookmakers/{bookmakerId}Pre-match by Fixture and Bookmaker ID
SportApioddsPreMatchByFixtureAndMarketIdGET /{version}/{sport}/odds/pre-match/fixtures/{fixtureId}/markets/{marketId}Pre-match by Fixture and Market ID
SportApioddsPreMatchByFixtureIdGET /{version}/{sport}/odds/pre-match/fixtures/{fixtureId}Pre-match by Fixture ID
SportApiplayerByIdGET /{version}/{sport}/players/{playerId}By ID
SportApiplayersAllGET /{version}/{sport}/playersAll
SportApiplayersByCountryIdGET /{version}/{sport}/players/countries/{countryId}By Country ID
SportApiplayersLatestGET /{version}/{sport}/players/latestLatest Updated
SportApiplayersSearchGET /{version}/{sport}/players/search/{name}Search
SportApipredictionsAllGET /{version}/{sport}/predictions/probabilitiesAll
SportApipredictionsAllValueBetsGET /{version}/{sport}/predictions/value-betsAll Value Bets
SportApipredictionsByFixtureIdGET /{version}/{sport}/predictions/probabilities/fixtures/{fixtureId}By Fixture ID
SportApipredictionsValueBetsByFixtureIdGET /{version}/{sport}/predictions/value-bets/fixtures/{fixtureId}Value Bets by Fixture ID
SportApirefereeByIdGET /{version}/{sport}/referees/{refereeId}By ID
SportApirefereesAllGET /{version}/{sport}/refereesAll
SportApirefereesByCountryIdGET /{version}/{sport}/referees/countries/{countryId}By Country ID
SportApirefereesBySeasonIdGET /{version}/{sport}/referees/seasons/{seasonId}By Season ID
SportApirefereesSearchGET /{version}/{sport}/referees/search/{name}Search
SportApirivalsAllGET /{version}/{sport}/rivalsAll
SportApirivalsByTeamIdGET /{version}/{sport}/rivals/teams/{teamId}By Team ID
SportApiroundByIdGET /{version}/{sport}/rounds/{roundId}By ID
SportApiroundsAllGET /{version}/{sport}/roundsAll
SportApiroundsBySeasonIdGET /{version}/{sport}/rounds/seasons/{seasonId}Season ID
SportApiroundsSearchGET /{version}/{sport}/rounds/search/{name}Search
SportApischedulesBySeasonIdGET /{version}/{sport}/schedules/seasons/{seasonId}By Season ID
SportApischedulesByTeamAndSeasonIdGET /{version}/{sport}/schedules/seasons/{seasonId}/teams/{teamId}By Team and Season ID
SportApischedulesByTeamIdGET /{version}/{sport}/schedules/teams/{teamId}By Team ID
SportApiseasonByIdGET /{version}/{sport}/seasons/{seasonId}By ID
SportApiseasonsAllGET /{version}/{sport}/seasonsAll
SportApiseasonsByTeamIdGET /{version}/{sport}/seasons/teams/{teamId}By Team ID
SportApiseasonsSearchGET /{version}/{sport}/seasons/search/{name}Search
SportApisquadsBySeasonAndTeamIdGET /{version}/{sport}/squads/seasons/{seasonId}/teams/{teamId}By Season and Team ID
SportApisquadsByTeamIdGET /{version}/{sport}/squads/teams/{teamId}By Team ID
SportApistageByIdGET /{version}/{sport}/stages/{stageId}By ID
SportApistagesAllGET /{version}/{sport}/stagesAll
SportApistagesBySeasonIdGET /{version}/{sport}/stages/seasons/{seasonId}By Season ID
SportApistagesSearchGET /{version}/{sport}/stages/search/{name}Search
SportApistandingCorrectionsBySeasonIdGET /{version}/{sport}/standings/corrections/seasons/{seasonId}Correction by Season ID
SportApistandingsAllGET /{version}/{sport}/standingsAll
SportApistandingsByRoundIdGET /{version}/{sport}/standings/rounds/{roundId}By Round ID
SportApistandingsBySeasonIdGET /{version}/{sport}/standings/seasons/{seasonId}By Season ID
SportApistandingsLiveByLeagueIdGET /{version}/{sport}/standings/live/leagues/{leagueId}By League ID
SportApistateByIdGET /{version}/{sport}/states/{stateId}By ID
SportApistatesBySportGET /{version}/{sport}/statesBy Sport
SportApiteamsAllGET /{version}/{sport}/teamsAll
SportApiteamsByCountryIdGET /{version}/{sport}/teams/countries/{countryId}By Country ID
SportApiteamsByIdGET /{version}/{sport}/teams/{teamId}By ID
SportApiteamsBySeasonIdGET /{version}/{sport}/teams/seasons/{seasonId}By Season ID
SportApiteamsSearchGET /{version}/{sport}/teams/search/{name}Search
SportApitopScorersBySeasonIdGET /{version}/{sport}/topscorers/seasons/{seasonId}By Season ID
SportApitopScorersByStageIdGET /{version}/{sport}/topscorers/stages/{stageId}By Stage ID
SportApitranfersByDateRangeGET /{version}/{sport}/transfers/between/{startDate}/{endDate}By Date Range
SportApitransferByIdGET /{version}/{sport}/transfers/{transferId}By ID
SportApitransfersAllGET /{version}/{sport}/transfersAll
SportApitransfersByPlayerIdGET /{version}/{sport}/transfers/players/{playerId}By Player ID
SportApitransfersByTeamIdGET /{version}/{sport}/transfers/teams/{teamId}By Team ID
SportApitransfersLatestGET /{version}/{sport}/transfers/latestLast Updated
SportApitvStationByIdGET /{version}/{sport}/tv-stations/{tvStationId}By ID
SportApitvStationsAllGET /{version}/{sport}/tv-stationsAll
SportApitvStationsByFixtureIdGET /{version}/{sport}/tv-stations/fixtures/{fixtureId}By Fixture ID
SportApivenueByIdGET /{version}/{sport}/venues/{venueId}By ID
SportApivenuesAllGET /{version}/{sport}/venuesAll
SportApivenuesBySeasonIdGET /{version}/{sport}/venues/seasons/{seasonId}By Season ID
SportApivenuesSearchGET /{version}/{sport}/venues/search/{name}Search
TypesApiallGET /{version}/core/typesAll
TypesApigetByIdGET /{version}/core/types/{typeId}By ID