-
Notifications
You must be signed in to change notification settings - Fork 5
/
football-standings-api.yaml
200 lines (200 loc) · 6.22 KB
/
football-standings-api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
openapi: 3.0.0
info:
title: Football Standings API
version: 1.0.0
description: API to retrieve football league standings and related data.
servers:
- url: https://api-football-standings.azharimm.dev
paths:
/leagues:
get:
summary: Get list of all available leagues
description: Get list of all available leagues
operationId: getLeagues
responses:
"200":
description: List of leagues
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
data:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
slug:
type: string
abbr:
type: string
logos:
type: object
properties:
light:
type: string
dark:
type: string
/leagues/{id}:
get:
summary: Get details for a specific league
description: Get details for a specific league
operationId: getLeagueDetails
parameters:
- name: id
in: path
description: The ID of the league to retrieve
required: true
schema:
type: string
responses:
"200":
description: League details
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
data:
type: object
properties:
id:
type: string
name:
type: string
slug:
type: string
abbr:
type: string
logos:
type: object
properties:
light:
type: string
dark:
type: string
/leagues/{id}/seasons:
get:
summary: Get seasons for a specific league
description: Get seasons for a specific league
operationId: getLeagueSeasonsAvailable
parameters:
- name: id
in: path
description: The ID of the league to retrieve seasons for
required: true
schema:
type: string
responses:
"200":
description: List of seasons for the league
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
data:
type: object
properties:
name:
type: string
desc:
type: string
abbreviation:
type: string
seasons:
type: array
items:
type: integer
/leagues/{id}/standings:
get:
summary: Get standings for a specific league and season
description: Get standings for a specific league and season. This returns a lot of data and you may need to trim the data.
operationId: getLeagueSeasonStandings
parameters:
- name: id
in: path
description: The ID of the league to retrieve standings for
required: true
schema:
type: string
- name: season
in: query
description: The season to retrieve standings for
required: true
schema:
type: integer
- name: sort
in: query
description: The sort order for standings (asc or desc)
schema:
type: string
enum: [asc, desc]
responses:
"200":
description: Standings for the league and season
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
data:
type: object
properties:
name:
type: string
abbreviation:
type: string
seasonDisplay:
type: string
season:
type: integer
standings:
type: array
items:
type: object
properties:
rank:
type: integer
teamName:
type: string
points:
type: integer
matches:
type: integer
wins:
type: integer
draws:
type: integer
losses:
type: integer
goalsFor:
type: integer
goalsAgainst:
type: integer
goalDifference:
type: integer
form:
type: string
description:
type: string
teamLogo:
type: string
teamId:
type: integer
teamSlug:
type: string
group:
type: string