mlbstats/api/docs/MiscApi.md

48 KiB

{{classname}}

All URIs are relative to https://statsapi.mlb.com

Method HTTP request Description
AggregateSortEnum Get /api/v1/sortModifiers List all stat fields
BaseballStats Get /api/v1/baseballStats List all baseball stats
BroadcastAvailabilityTypes Get /api/v1/broadcastAvailability View broadcast availability options
CoachingVideoTypes Get /api/v1/coachingVideoTypes List all coaching video types
EventStatus Get /api/v1/eventStatus List all possible event status types
EventTypes Get /api/v1/eventTypes List all event types
FielderDetailTypes Get /api/v1/fielderDetailTypes List fielder detail types
FreeGameTypes Get /api/v1/freeGameTypes View free game types
GameStatus Get /api/v1/gameStatus List all status types
GameTypes Get /api/v1/gameTypes List all game types
GamedayTypes Get /api/v1/gamedayTypes List all gameday types
GetLookupValues Get /api/v1/lookup/values/all View all lookup values
GroupByTypes Get /api/v1/groupByTypes List groupBy types
HitTrajectories Get /api/v1/hitTrajectories List all hit trajectories
JobTypes Get /api/v1/jobTypes List all job types
Languages Get /api/v1/languages List all support languages
LeagueLeaderTypes Get /api/v1/leagueLeaderTypes List all possible player league leader types
LogicalEvents Get /api/v1/logicalEvents List all logical event types
MediaStateTypes Get /api/v1/mediaState View media state options
Metrics Get /api/v1/metrics List all possible metrics
MoundVisitTypes Get /api/v1/moundVisitTypes List all mound visit types
PerformerTypes Get /api/v1/performerTypes List all possible performer types
PitchCodes Get /api/v1/pitchCodes List all pitch codes
PitchTypes Get /api/v1/pitchTypes List all pitch classification types
Platforms Get /api/v1/platforms List all possible platforms
PlayerStatusCodes Get /api/v1/playerStatusCodes List all player status codes
Positions Get /api/v1/positions List all possible positions
ReviewReasons Get /api/v1/reviewReasons List all replay review reasons
RoofTypes Get /api/v1/roofTypes List all roof types
RosterTypes Get /api/v1/rosterTypes List all possible roster types
RuleSettings Get /api/v1/ruleSettings List all ruleSettings
RunnerDetailTypes Get /api/v1/runnerDetailTypes List runner detail types
ScheduleEventTypes Get /api/v1/scheduleEventTypes List all schedule event types
ScheduleTypes Get /api/v1/scheduleTypes List all possible schedule types
SitCodes Get /api/v1/situationCodes List all situation codes
Sky Get /api/v1/sky List all sky options
StandingsTypes Get /api/v1/standingsTypes List all standings types
StatFields Get /api/v1/statFields List all stat fields
StatGroups Get /api/v1/statGroups List all stat groups
StatSearchConfig Get /api/v1/stats/search/config Stats Search Config Endpoint
StatSearchGroupByTypes Get /api/v1/stats/search/groupByTypes List groupBy types
StatSearchParams Get /api/v1/stats/search/params List stat search parameters
StatSearchStats Get /api/v1/stats/search/stats List stat search stats
StatTypes Get /api/v1/statTypes List all stat types
StatcastPositionTypes Get /api/v1/statcastPositionTypes List all statcast position types
TrackingSoftwareVersions Get /api/v1/trackingSoftwareVersions List the tracking software versions and notes
TrackingSystemOwners Get /api/v1/trackingSystemOwners List all tracking system owners
TrackingVendors Get /api/v1/trackingVendors List all tracking vendors
TrackingVersions Get /api/v1/trackingVersions List all tracking versions
TransactionTypes Get /api/v1/transactionTypes List all transaction types
UpdateGameStatuses Post /api/v1/gameStatus Clear all status types
UpdateJobTypes Post /api/v1/jobTypes
VideoResolutionTypes Get /api/v1/videoResolutionTypes View video resolution options
ViolationTypes Get /api/v1/violationTypes View available violationType options
WeatherTrajectoryConfidences Get /api/v1/weatherTrajectoryConfidences List all weather trajectories
WindDirection Get /api/v1/windDirection List all wind direction options

AggregateSortEnum

[]AggregateSortTypeRestObject AggregateSortEnum(ctx, ) List all stat fields

Required Parameters

This endpoint does not need any parameter.

Return type

**[]AggregateSortTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BaseballStats

[]BaseballStatsTypeRestObject BaseballStats(ctx, ) List all baseball stats

Required Parameters

This endpoint does not need any parameter.

Return type

**[]BaseballStatsTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BroadcastAvailabilityTypes

[]BroadcastAvailabilityRestObject BroadcastAvailabilityTypes(ctx, ) View broadcast availability options

Required Parameters

This endpoint does not need any parameter.

Return type

**[]BroadcastAvailabilityRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CoachingVideoTypes

[]string CoachingVideoTypes(ctx, ) List all coaching video types

Required Parameters

This endpoint does not need any parameter.

Return type

[]string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EventStatus

[]IGameStatus EventStatus(ctx, ) List all possible event status types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]IGameStatus**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EventTypes

string EventTypes(ctx, optional) List all event types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiEventTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiEventTypesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FielderDetailTypes

[]FielderDetailType FielderDetailTypes(ctx, ) List fielder detail types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]FielderDetailType**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FreeGameTypes

[]FreeGameTypeRestObject FreeGameTypes(ctx, ) View free game types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]FreeGameTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GameStatus

[]RestObject GameStatus(ctx, ) List all status types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]RestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GameTypes

[]GameTypeEnum GameTypes(ctx, optional) List all game types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiGameTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiGameTypesOpts struct

Name Type Description Notes
sportId optional.Int32 Top level organization of a sport
leagueId optional.Int32 Unique League Identifier
season optional.String Season of play

Return type

**[]GameTypeEnum**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GamedayTypes

[]GeneralLookupRestObject GamedayTypes(ctx, optional) List all gameday types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiGamedayTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiGamedayTypesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLookupValues

map[string][]interface{} GetLookupValues(ctx, ) View all lookup values

Required Parameters

This endpoint does not need any parameter.

Return type

**map[string][]interface{}**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GroupByTypes

[]GroupByEnum GroupByTypes(ctx, ) List groupBy types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]GroupByEnum**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HitTrajectories

[]GeneralLookupRestObject HitTrajectories(ctx, optional) List all hit trajectories

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiHitTrajectoriesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiHitTrajectoriesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobTypes

[]JobTypeRestObject JobTypes(ctx, optional) List all job types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiJobTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiJobTypesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]JobTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Languages

[]Language Languages(ctx, ) List all support languages

Required Parameters

This endpoint does not need any parameter.

Return type

**[]Language**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LeagueLeaderTypes

[]LeagueLeaderTypeRestObject LeagueLeaderTypes(ctx, ) List all possible player league leader types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]LeagueLeaderTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LogicalEvents

[]GeneralLookupRestObject LogicalEvents(ctx, optional) List all logical event types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiLogicalEventsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiLogicalEventsOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MediaStateTypes

[]MediaStateRestObject MediaStateTypes(ctx, ) View media state options

Required Parameters

This endpoint does not need any parameter.

Return type

**[]MediaStateRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Metrics

[]RestObject Metrics(ctx, ) List all possible metrics

Required Parameters

This endpoint does not need any parameter.

Return type

**[]RestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MoundVisitTypes

[]GeneralLookupRestObject MoundVisitTypes(ctx, optional) List all mound visit types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiMoundVisitTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiMoundVisitTypesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PerformerTypes

[]PerformerType PerformerTypes(ctx, ) List all possible performer types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]PerformerType**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PitchCodes

[]PitchCodeRestObject PitchCodes(ctx, optional) List all pitch codes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiPitchCodesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiPitchCodesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]PitchCodeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PitchTypes

[]GeneralLookupRestObject PitchTypes(ctx, optional) List all pitch classification types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiPitchTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiPitchTypesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Platforms

[]Platform Platforms(ctx, ) List all possible platforms

Required Parameters

This endpoint does not need any parameter.

Return type

**[]Platform**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PlayerStatusCodes

[]GeneralLookupRestObject PlayerStatusCodes(ctx, optional) List all player status codes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiPlayerStatusCodesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiPlayerStatusCodesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Positions

[]BaseballPosition Positions(ctx, ) List all possible positions

Required Parameters

This endpoint does not need any parameter.

Return type

**[]BaseballPosition**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReviewReasons

[]GeneralLookupRestObject ReviewReasons(ctx, optional) List all replay review reasons

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiReviewReasonsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiReviewReasonsOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RoofTypes

[]RoofTypeRestObject RoofTypes(ctx, ) List all roof types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]RoofTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RosterTypes

[]RosterType RosterTypes(ctx, ) List all possible roster types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]RosterType**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RuleSettings

[]RuleSettingsRestObject RuleSettings(ctx, ) List all ruleSettings

Required Parameters

This endpoint does not need any parameter.

Return type

**[]RuleSettingsRestObject**

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RunnerDetailTypes

[]RunnerDetailType RunnerDetailTypes(ctx, ) List runner detail types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]RunnerDetailType**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ScheduleEventTypes

[]ScheduleEventTypeRestObject ScheduleEventTypes(ctx, optional) List all schedule event types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiScheduleEventTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiScheduleEventTypesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]ScheduleEventTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ScheduleTypes

[]ScheduleTypeEnum ScheduleTypes(ctx, ) List all possible schedule types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]ScheduleTypeEnum**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SitCodes

[]SituationCodeRestObject SitCodes(ctx, optional) List all situation codes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiSitCodesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiSitCodesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute
season optional.String Season of play
statGroup optional.Interface of StatGroup Category of statistic to return. Available types in /api/v1/statGroups

Return type

**[]SituationCodeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Sky

[]GeneralLookupRestObject Sky(ctx, optional) List all sky options

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiSkyOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiSkyOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StandingsTypes

[]StandingsType StandingsTypes(ctx, ) List all standings types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]StandingsType**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatFields

[]StatField StatFields(ctx, ) List all stat fields

Required Parameters

This endpoint does not need any parameter.

Return type

**[]StatField**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatGroups

[]StatGroup StatGroups(ctx, ) List all stat groups

Required Parameters

This endpoint does not need any parameter.

Return type

**[]StatGroup**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatSearchConfig

StatSearchConfigRestObject StatSearchConfig(ctx, optional) Stats Search Config Endpoint

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiStatSearchConfigOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiStatSearchConfigOpts struct

Name Type Description Notes
filterLevel optional.Interface of FilterLevelEnum Categories of filters for stat search
group optional.Interface of StatGroup Category of statistic to return. Available types in /api/v1/statGroups

Return type

StatSearchConfigRestObject

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatSearchGroupByTypes

[]GroupByEnum StatSearchGroupByTypes(ctx, optional) List groupBy types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiStatSearchGroupByTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiStatSearchGroupByTypesOpts struct

Name Type Description Notes
filterLevel optional.Interface of FilterLevelEnum Categories of filters for stat search

Return type

**[]GroupByEnum**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatSearchParams

[]StatSearchParamRestObject StatSearchParams(ctx, optional) List stat search parameters

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiStatSearchParamsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiStatSearchParamsOpts struct

Name Type Description Notes
filterLevel optional.Interface of FilterLevelEnum Categories of filters for stat search

Return type

**[]StatSearchParamRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatSearchStats

[]StatSearchStatRestObject StatSearchStats(ctx, optional) List stat search stats

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiStatSearchStatsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiStatSearchStatsOpts struct

Name Type Description Notes
filterLevel optional.Interface of FilterLevelEnum Categories of filters for stat search

Return type

**[]StatSearchStatRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatTypes

[]StatType StatTypes(ctx, ) List all stat types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]StatType**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StatcastPositionTypes

[]StatcastPositionRestObject StatcastPositionTypes(ctx, ) List all statcast position types

Required Parameters

This endpoint does not need any parameter.

Return type

**[]StatcastPositionRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TrackingSoftwareVersions

[]TrackingSoftwareVersionRestObject TrackingSoftwareVersions(ctx, ) List the tracking software versions and notes

Required Parameters

This endpoint does not need any parameter.

Return type

**[]TrackingSoftwareVersionRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TrackingSystemOwners

[]TrackingSystemOwner TrackingSystemOwners(ctx, ) List all tracking system owners

Required Parameters

This endpoint does not need any parameter.

Return type

**[]TrackingSystemOwner**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TrackingVendors

[]TrackingVendor TrackingVendors(ctx, ) List all tracking vendors

Required Parameters

This endpoint does not need any parameter.

Return type

**[]TrackingVendor**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TrackingVersions

[]TrackingVersion TrackingVersions(ctx, ) List all tracking versions

Required Parameters

This endpoint does not need any parameter.

Return type

**[]TrackingVersion**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TransactionTypes

[]GeneralLookupRestObject TransactionTypes(ctx, optional) List all transaction types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiTransactionTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiTransactionTypesOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateGameStatuses

string UpdateGameStatuses(ctx, ) Clear all status types

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateJobTypes

string UpdateJobTypes(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VideoResolutionTypes

[]VideoResolutionEnumRestObject VideoResolutionTypes(ctx, ) View video resolution options

Required Parameters

This endpoint does not need any parameter.

Return type

**[]VideoResolutionEnumRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ViolationTypes

[]ViolationTypeRestObject ViolationTypes(ctx, ) View available violationType options

Required Parameters

This endpoint does not need any parameter.

Return type

**[]ViolationTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WeatherTrajectoryConfidences

[]WeatherTrajectoryConfidenceTypeRestObject WeatherTrajectoryConfidences(ctx, ) List all weather trajectories

Required Parameters

This endpoint does not need any parameter.

Return type

**[]WeatherTrajectoryConfidenceTypeRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WindDirection

[]GeneralLookupRestObject WindDirection(ctx, optional) List all wind direction options

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *MiscApiWindDirectionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a MiscApiWindDirectionOpts struct

Name Type Description Notes
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]GeneralLookupRestObject**

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]