Documentation / Players
List players
GET /v1/playersPlayers by part of the name, position, nationality or birth year.
GET
https://api.icehockeyapi.com/v1/playershttps://api.icehockeyapi.com/v1/players?q=Rempe&per_page=3curl "https://api.icehockeyapi.com/v1/players?q=Rempe&per_page=3" \ -H "X-API-Key: YOUR_KEY"
200 OKExample answer from the data, 12 Oct
{
"data": [
{
"id": "pl_zgna58ee",
"name": "Matt Rempe",
"first_name": "Matt",
"last_name": "Rempe",
"position": "center",
"shoots": "right",
"birth_date": "2002-06-29",
"birth_place": "Calgary, Alberta",
"birth_country": "CAN",
"nationality": null,
"height_cm": 206,
"weight_kg": 122
},
{
"id": "pl_qgrny56g",
"name": "Matt Rempe",
"first_name": "Matt",
"last_name": "Rempe",
"position": "right_wing",
"shoots": null,
"birth_date": null,
"birth_place": null,
"birth_country": null,
"nationality": null,
"height_cm": null,
"weight_kg": null
},
{
"id": "pl_fyfwe6my",
"name": "Matthew Rempe",
"first_name": "Matthew",
"last_name": "Rempe",
"position": "center",
"shoots": null,
"birth_date": null,
"birth_place": null,
"birth_country": null,
"nationality": null,
"height_cm": null,
"weight_kg": null
}
],
"meta": {
"count": 3,
"next_cursor": "eyJvIjozLCJuIjozfQ",
"page": 1,
"per_page": 3,
"total": 8,
"total_pages": 3,
"next_page": 2,
"prev_page": null,
"plan": "Complete"
}
}Run works once the API is live; the code above works now.
Parameters
| Name | In | Type | What it does |
|---|---|---|---|
q | query | string | Part of the name |
position | query | enum | A position. centerleft_wingright_wingdefensegoalieforward |
nationality | query | string | Nationality as players show it, like FIN or CAN |
born | query | int | Birth year |
page | query | int | The page, from 1. |
per_page | query | int | Records a page, default 50, at most 200. |
cursor | query | string | meta.next_cursor from the previous answer. |
Returns
| Field | Type |
|---|---|
id | string |
name | string |
first_name | string |
last_name | string |
position | string |
shoots | string |
birth_date | string |
birth_place | string |
birth_country | string |
nationality | null |
height_cm | int |
weight_kg | int |