mlbstats/api/docs/BiomechanicsAPI.md

2.5 KiB

\BiomechanicsAPI

All URIs are relative to http://localhost

Method HTTP request Description
Biomechanical Get /api/v1/game/{gamePk}/{playId}/analytics/biomechanics/{positionId} View Biomechanical data by playId and gameId filtered by player positionId

Biomechanical

Biomechanical(ctx, gamePk, playId, positionId).Fields(fields).Execute()

View Biomechanical data by playId and gameId filtered by player positionId

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "//"
)

func main() {
	gamePk := TODO // interface{} | Unique Primary Key Representing a Game
	playId := TODO // interface{} | Unique play identifier
	positionId := TODO // interface{} | Position number. Format: 1, 2, 3, etc
	fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.BiomechanicsAPI.Biomechanical(context.Background(), gamePk, playId, positionId).Fields(fields).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BiomechanicsAPI.Biomechanical``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
gamePk interface{} Unique Primary Key Representing a Game
playId interface{} Unique play identifier
positionId interface{} Position number. Format: 1, 2, 3, etc

Other Parameters

Other parameters are passed through a pointer to a apiBiomechanicalRequest struct via the builder pattern

Name Type Description Notes

fields | interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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