Overview
GetGamePropertyInfo returns valid Game Property types for the current sport.
This endpoint returns additional metadata for each Game Property type, including the key, data type, display name, supported enum values, and supported operand types.
Use GetGamePropertyInfo when you need detailed Game Property metadata.
If you only need the names of available Game Property types, use GetGameProperties.
Endpoint
GET https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetGamePropertyInfoAuthentication Headers
GetGamePropertyInfo requires API authentication headers.
For required authentication headers and how to generate the authorization value, see:
Thunder API – Authentication Headers
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
includeEnums |
boolean | No | When true, populates the list of available values from GetGamePropertyValues into the EnumValues property. When false, EnumValues is not populated. |
Request Format
Parameters are submitted as query string values.
https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetGamePropertyInfo?includeEnums=falseResponse
The API returns a list of Game Property metadata objects.
Response content type:
application/jsonExample response structure:
[
{
"Key": "GameDate",
"DataType": "System.DateTime",
"DisplayName": "Game Date",
"EnumValues": [],
"OperandTypes": [
"Equal",
"Is_In_Between",
"Less_Than",
"Greater_Than"
]
},
{
"Key": "GameType",
"DataType": "System.String",
"DisplayName": "Game Type",
"EnumValues": [],
"OperandTypes": [
"Equal"
]
}
]Response Fields
| Field | Description |
|---|---|
Key |
Game Property key used by Thunder APIs |
DataType |
Data type for the Game Property |
DisplayName |
Display name for the Game Property |
EnumValues |
Available values for the Game Property when includeEnums=true
|
OperandTypes |
Supported operators for the Game Property |
Example Game Property Keys
Common Game Property keys include:
| Key | Description |
|---|---|
GameDate |
Game date |
GameType |
Game type |
HomeTeamId |
Home team GUID |
AwayTeamId |
Away team GUID |
ScoutedTeamId |
Scouted team GUID |
ParticipatingTeamId |
Home or away team GUID |
HomeTeamCode |
Home team abbreviation |
AwayTeamCode |
Away team abbreviation |
ScoutedTeamCode |
Scouted team abbreviation |
ParticipatingTeamCode |
Home or away team abbreviation |
ScoutedTeamODK |
Scouted team ODK value |
UsedBy |
Used By group name |
Example Usage
Game Property keys can be used with SearchForPlaysComplex by using the gamepropertykey attribute.
<criterias>
<criteria op='Equal' gamepropertykey='GameType' val='Regular Season'/>
<criteria op='Equal' gamepropertykey='ScoutedTeamId' val='TEAM_GUID'/>
</criterias>Notes
-
GetGamePropertyInforeturns metadata for valid Game Property types for the current sport. - Use
includeEnums=truewhen available enum values are needed. - Use
includeEnums=falsewhen only metadata and supported operators are needed. - Use
GetGamePropertieswhen only the names of Game Property types are needed. -
OperandTypesidentifies the operators supported by each Game Property.
Comments
0 comments
Please sign in to leave a comment.