7.3 KiB
{{classname}}
All URIs are relative to https://statsapi.mlb.com
| Method | HTTP request | Description |
|---|---|---|
| Datacasters | Get /api/v1/jobs/datacasters | Get datacaster jobs |
| GetJobsByType | Get /api/v1/jobs | Get jobs by type |
| OfficialScorers | Get /api/v1/jobs/officialScorers | Get official scorers |
| UmpireSchedule | Get /api/v1/jobs/umpires/games/{umpireId} | Get umpires and associated game for umpireId |
| Umpires | Get /api/v1/jobs/umpires | Get umpires |
Datacasters
RosterRestObject Datacasters(ctx, optional) Get datacaster jobs
Get datacaster jobs
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *JobApiDatacastersOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a JobApiDatacastersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| sportId | optional.Int32 | Top level organization of a sport | |
| date | optional.String | Date of Game. Format: YYYY-MM-DD | |
| fields | **optional.Interface of []string** | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
Return type
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]
GetJobsByType
RosterRestObject GetJobsByType(ctx, jobType, optional) Get jobs by type
This endpoint allows you to pull teams
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| jobType | string | Job Type Identifier (ie. UMPR, etc..) | |
| optional | *JobApiGetJobsByTypeOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a JobApiGetJobsByTypeOpts struct
| Name | Type | Description | Notes |
|---|
sportId | optional.Int32| Top level organization of a sport | date | optional.String| Date of Game. Format: YYYY-MM-DD | fields | **optional.Interface of []string**| Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
Return type
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]
OfficialScorers
RosterRestObject OfficialScorers(ctx, optional) Get official scorers
This endpoint allows you to pull teams
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *JobApiOfficialScorersOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a JobApiOfficialScorersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| sportId | optional.Int32 | Top level organization of a sport | |
| date | optional.String | Date of Game. Format: YYYY-MM-DD | |
| fields | **optional.Interface of []string** | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
Return type
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]
UmpireSchedule
ScheduleRestObject UmpireSchedule(ctx, umpireId, season, optional) Get umpires and associated game for umpireId
This endpoint allows you to pull teams
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| umpireId | int32 | A unique identifier for an umpire | |
| season | string | Season of play | |
| optional | *JobApiUmpireScheduleOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a JobApiUmpireScheduleOpts 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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Umpires
RosterRestObject Umpires(ctx, optional) Get umpires
This endpoint allows you to pull teams
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *JobApiUmpiresOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a JobApiUmpiresOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| sportId | optional.Int32 | Top level organization of a sport | |
| date | optional.String | Date of Game. Format: YYYY-MM-DD | |
| fields | **optional.Interface of []string** | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute | |
| season | optional.String | Season of play |
Return type
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]