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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Matches — Battelrite 0.2 documentation</title>
<link rel="stylesheet" href="../_static/css/battlerite.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Match Data Summary" href="../match_data_summary/match_data_summary.html" />
<link rel="prev" title="Receiving Responses" href="../receivingresponses/receivingresponses.html" />
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
</head>
<body>
<header id="BTT" role="banner">
<div class="menu-top-outer clearfix">
<div class="wrapper clearfix">
<a href="/" id="site-logo"></a>
<span id="logSignBtn" class="btn">Login / Signup</span>
<nav id="mainMenu" class="main-menu-con">
<ul class="main-menu clearfix">
<li><a class="active" href="guides.html">Documentation</a></li>
<li><a href="faq.html">Faqs</a></li>
<li><a href="creations.html">Creations</a></li>
</ul>
</nav>
</div>
</div>
</header>
<div class="related top">
<nav id="rellinks">
<ul>
<li>
←
<a href="../receivingresponses/receivingresponses.html" title="Previous document">Receiving Responses</a>
</li>
<li>
<a href="../match_data_summary/match_data_summary.html" title="Next document">Match Data Summary</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="../index.html">Battelrite 0.2 documentation</a></li>
</ul>
</nav>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="matches">
<span id="id1"></span><h1>Matches<a class="headerlink" href="#matches" title="Permalink to this headline">¶</a></h1>
<p>Matches records are created every time players complete a game session. Each Match contains high level information about the game session, including info like duration, gameMode, and more. Each Match has two Rosters.</p>
<div class="section" id="rosters">
<h2>Rosters<a class="headerlink" href="#rosters" title="Permalink to this headline">¶</a></h2>
<p>Rosters track the scores of each opposing group of Participants. If players entered matchmaking as a team, the Roster will have a related Team. Rosters have many Participants objects, one for each member of the Roster. Roster objects are only meaningful within the context of a Match and are not exposed as a standalone resource.</p>
<p><strong>Javascript:</strong></p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"roster"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"eca49808-d510-11e6-bf26-cec0c932ce01"</span><span class="p">,</span>
<span class="s2">"attributes"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"stats"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"acesEarned"</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s2">"gold"</span><span class="o">:</span> <span class="mi">32344</span><span class="p">,</span>
<span class="s2">"etc..."</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"relationships"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"team"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"team"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"753d464c-d511-11e6-bf26-cec0c932ce01"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"participants"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"participant"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"eca49a7e-d510-11e6-bf26-cec0c932ce01"</span>
<span class="p">},</span>
<span class="s2">"etc..."</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="participants">
<h2>Participants<a class="headerlink" href="#participants" title="Permalink to this headline">¶</a></h2>
<p>Participant objects track each member in a Roster. Participants may be anonymous Players, registered Players, or bots. In the case where the Participant is a registered Player, the Participant will have a single Player relationship. Participant objects are only meaningful within the context of a Match and are not exposed as a standalone resource.</p>
<p><strong>Javascript:</strong></p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"participant"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"ea77c3a7-d44e-11e6-8f77-0242ac130004"</span><span class="p">,</span>
<span class="s2">"attributes"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"actor"</span><span class="o">:</span> <span class="s2">"*Hero009*"</span><span class="p">,</span>
<span class="s2">"stats"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"assists"</span><span class="o">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s2">"crystalMineCaptures"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"deaths"</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s2">"farm"</span><span class="o">:</span> <span class="mf">49.25</span><span class="p">,</span>
<span class="s2">"etc..."</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="get-a-collection-of-matches">
<h2>Get a Collection of Matches<a class="headerlink" href="#get-a-collection-of-matches" title="Permalink to this headline">¶</a></h2>
<p>This endpoint retrieves data from matches. Bulk scraping matches is prohibited.</p>
<p><strong>HTTP Request</strong>
| <code class="docutils literal"><span class="pre">GET</span> <span class="pre">https://api.dc01.gamelockerapp.com/shards/na/matches</span></code></p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="10%" />
<col width="73%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Default</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>page[offset]</td>
<td>0</td>
<td>Allows paging over results</td>
</tr>
<tr class="row-odd"><td>page[limit ]</td>
<td>50</td>
<td>The default (and current maximum) is 50.Values less than 50 and great than 2 are supported.</td>
</tr>
<tr class="row-even"><td>sort</td>
<td>createdAt</td>
<td>By default, Matches are sorted by creation time ascending.</td>
</tr>
<tr class="row-odd"><td>filter[createdAt-start]</td>
<td>3hrs ago</td>
<td>Must occur before end time. Format is iso8601 Usage: filter[createdAt-start]=2017-01-01T08:25:30Z</td>
</tr>
<tr class="row-even"><td>filter[createdAt-end]</td>
<td>Now</td>
<td>Queries search the last 3 hrs. Format is iso8601 i.e.filter[createdAt-end]=2017-01-01T13:25:30Z</td>
</tr>
<tr class="row-odd"><td>filter[playerNames]</td>
<td>none</td>
<td>Filters by player name. Usage: filter[playerNames]=player1,player2,…</td>
</tr>
<tr class="row-even"><td>filter[playerIds]</td>
<td>none</td>
<td>Filters by player Id. Usage:filter[playerIds]=playerId,playerId,…</td>
</tr>
<tr class="row-odd"><td>filter[teamNames]</td>
<td>none</td>
<td>Filters by team names. Team names are the same as the in game team tags. Usage: filter[teamNames]=TSM,team2,…</td>
</tr>
<tr class="row-even"><td>filter[gameMode]</td>
<td>none</td>
<td>Filter by gameMode Usage: filter[gameMode]=casual,ranked,…</td>
</tr>
</tbody>
</table>
<p><em>Remember — a happy match is an authenticated match!</em></p>
<p><strong>Shell:</strong></p>
<div class="highlight-shell"><div class="highlight"><pre><span></span> curl -g <span class="s2">"https://api.dc01.gamelockerapp.com/shards/na/matches?sort=createdAt&page[limit]=3&filter[createdAt-start]=2017-02-27T13:25:30Z&filter[playerNames]=<playerName>"</span> <span class="se">\</span>
-H <span class="s2">"Authorization: Bearer <api-key>"</span> <span class="se">\</span>
-H <span class="s2">"Accept: application/vnd.api+json"</span>
//The above <span class="nb">command</span> returns JSON structured like this:
<span class="o">{</span>
<span class="s2">"data"</span>: <span class="o">[</span>
<span class="o">{</span>
<span class="s2">"type"</span>: <span class="s2">"match"</span>,
<span class="s2">"id"</span>: <span class="s2">"02b90214-c64d-11e6-9f6b-062445d3d668"</span>,
<span class="s2">"attributes"</span>: <span class="o">{</span>
<span class="s2">"createdAt"</span>: <span class="s2">"2017-01-06T20:30:08Z"</span>,
<span class="s2">"duration"</span>: <span class="m">1482195372</span>,
<span class="s2">"gameMode"</span>: <span class="s2">"casual"</span>,
<span class="s2">"patchVersion"</span>: <span class="s2">"1.0.0"</span>,
<span class="s2">"shardId"</span>: <span class="s2">"na"</span>,
<span class="s2">"stats"</span>: <span class="s2">"acesEarned: 3, etc..."</span>
<span class="o">}</span>,
<span class="s2">"relationships"</span>: <span class="o">{</span>
<span class="s2">"rosters"</span>: <span class="o">{</span>
<span class="s2">"data"</span>: <span class="o">[{</span>
<span class="s2">"type"</span>: <span class="s2">"roster"</span>,
<span class="s2">"id"</span>: <span class="s2">"ea77c2eb-d44e-11e6-8f77-0242ac130004"</span>
<span class="o">}</span>, <span class="o">{</span>
<span class="s2">"type"</span>: <span class="s2">"roster"</span>,
<span class="s2">"id"</span>: <span class="s2">"dc2c14b4-d50c-11e6-bf26-cec0c932ce01"</span>
<span class="o">}]</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">]</span>
<span class="o">}</span>
</pre></div>
</div>
<p><strong>Java:</strong></p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="c1">//*There are a variety of Java HTTP libraries that support query-parameters.</span>
<span class="c1">//The above command returns JSON structured like this:</span>
<span class="o">{</span>
<span class="s">"data"</span><span class="o">:</span> <span class="o">[</span>
<span class="o">{</span>
<span class="s">"type"</span><span class="o">:</span> <span class="s">"match"</span><span class="o">,</span>
<span class="s">"id"</span><span class="o">:</span> <span class="s">"02b90214-c64d-11e6-9f6b-062445d3d668"</span><span class="o">,</span>
<span class="s">"attributes"</span><span class="o">:</span> <span class="o">{</span>
<span class="s">"createdAt"</span><span class="o">:</span> <span class="s">"2017-01-06T20:30:08Z"</span><span class="o">,</span>
<span class="s">"duration"</span><span class="o">:</span> <span class="mi">1482195372</span><span class="o">,</span>
<span class="s">"gameMode"</span><span class="o">:</span> <span class="s">"casual"</span><span class="o">,</span>
<span class="s">"patchVersion"</span><span class="o">:</span> <span class="s">"1.0.0"</span><span class="o">,</span>
<span class="s">"shardId"</span><span class="o">:</span> <span class="s">"na"</span><span class="o">,</span>
<span class="s">"stats"</span><span class="o">:</span> <span class="s">"acesEarned: 3, etc..."</span>
<span class="o">},</span>
<span class="s">"relationships"</span><span class="o">:</span> <span class="o">{</span>
<span class="s">"rosters"</span><span class="o">:</span> <span class="o">{</span>
<span class="s">"data"</span><span class="o">:</span> <span class="o">[{</span>
<span class="s">"type"</span><span class="o">:</span> <span class="s">"roster"</span><span class="o">,</span>
<span class="s">"id"</span><span class="o">:</span> <span class="s">"ea77c2eb-d44e-11e6-8f77-0242ac130004"</span>
<span class="o">},</span> <span class="o">{</span>
<span class="s">"type"</span><span class="o">:</span> <span class="s">"roster"</span><span class="o">,</span>
<span class="s">"id"</span><span class="o">:</span> <span class="s">"dc2c14b4-d50c-11e6-bf26-cec0c932ce01"</span>
<span class="o">}]</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">]</span>
<span class="o">}</span>
</pre></div>
</div>
<p><strong>Python:</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">requests</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"https://api.dc01.gamelockerapp.com/shards/na/matches"</span>
<span class="n">header</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"Authorization"</span><span class="p">:</span> <span class="s2">"<api-key>"</span><span class="p">,</span>
<span class="s2">"Accept"</span><span class="p">:</span> <span class="s2">"application/vnd.api+json"</span>
<span class="p">}</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"sort"</span><span class="p">:</span> <span class="s2">"createdAt"</span><span class="p">,</span>
<span class="s2">"filter[playerNames]"</span><span class="p">:</span> <span class="s2">"<playerName>"</span><span class="p">,</span>
<span class="s2">"filter[createdAt-start]"</span><span class="p">:</span> <span class="s2">"2017-02-28T13:25:30Z"</span><span class="p">,</span>
<span class="s2">"page[limit]"</span><span class="p">:</span> <span class="s2">"3"</span>
<span class="p">}</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">header</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">query</span><span class="p">)</span>
<span class="o">//</span><span class="n">The</span> <span class="n">above</span> <span class="n">command</span> <span class="n">returns</span> <span class="n">JSON</span> <span class="n">structured</span> <span class="n">like</span> <span class="n">this</span><span class="p">:</span>
<span class="p">{</span>
<span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"match"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"02b90214-c64d-11e6-9f6b-062445d3d668"</span><span class="p">,</span>
<span class="s2">"attributes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"createdAt"</span><span class="p">:</span> <span class="s2">"2017-01-06T20:30:08Z"</span><span class="p">,</span>
<span class="s2">"duration"</span><span class="p">:</span> <span class="mi">1482195372</span><span class="p">,</span>
<span class="s2">"gameMode"</span><span class="p">:</span> <span class="s2">"casual"</span><span class="p">,</span>
<span class="s2">"patchVersion"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
<span class="s2">"shardId"</span><span class="p">:</span> <span class="s2">"na"</span><span class="p">,</span>
<span class="s2">"stats"</span><span class="p">:</span> <span class="s2">"acesEarned: 3, etc..."</span>
<span class="p">},</span>
<span class="s2">"relationships"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"rosters"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"data"</span><span class="p">:</span> <span class="p">[{</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"roster"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ea77c2eb-d44e-11e6-8f77-0242ac130004"</span>
<span class="p">},</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"roster"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"dc2c14b4-d50c-11e6-bf26-cec0c932ce01"</span>
<span class="p">}]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p><strong>Go:</strong></p>
<div class="highlight-go"><div class="highlight"><pre><span></span><span class="nx">q</span> <span class="o">:=</span> <span class="nx">req</span><span class="p">.</span><span class="nx">URL</span><span class="p">.</span><span class="nx">Query</span><span class="p">()</span>
<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">"sort"</span><span class="p">,</span> <span class="s">"createdAt"</span><span class="p">)</span>
<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">"filter[playerNames]"</span><span class="p">,</span> <span class="s">"<playerName>"</span><span class="p">)</span>
<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">"filter[createdAt-start]"</span><span class="p">,</span> <span class="s">"2017-02-27T13:25:30Z"</span><span class="p">)</span>
<span class="nx">q</span><span class="p">.</span><span class="nx">Add</span><span class="p">(</span><span class="s">"page[limit]"</span><span class="p">,</span> <span class="s">"3"</span><span class="p">)</span>
<span class="nx">req</span><span class="p">.</span><span class="nx">URL</span><span class="p">.</span><span class="nx">RawQuery</span> <span class="p">=</span> <span class="nx">q</span><span class="p">.</span><span class="nx">Encode</span><span class="p">()</span>
<span class="nx">res</span><span class="p">,</span> <span class="nx">_</span> <span class="o">:=</span> <span class="nx">client</span><span class="p">.</span><span class="nx">Do</span><span class="p">(</span><span class="nx">req</span><span class="p">)</span>
<span class="c1">//The above command returns JSON structured like this:</span>
<span class="p">{</span>
<span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">"type"</span><span class="p">:</span> <span class="s">"match"</span><span class="p">,</span>
<span class="s">"id"</span><span class="p">:</span> <span class="s">"02b90214-c64d-11e6-9f6b-062445d3d668"</span><span class="p">,</span>
<span class="s">"attributes"</span><span class="p">:</span> <span class="p">{</span>
<span class="s">"createdAt"</span><span class="p">:</span> <span class="s">"2017-01-06T20:30:08Z"</span><span class="p">,</span>
<span class="s">"duration"</span><span class="p">:</span> <span class="mi">1482195372</span><span class="p">,</span>
<span class="s">"gameMode"</span><span class="p">:</span> <span class="s">"casual"</span><span class="p">,</span>
<span class="s">"patchVersion"</span><span class="p">:</span> <span class="s">"1.0.0"</span><span class="p">,</span>
<span class="s">"shardId"</span><span class="p">:</span> <span class="s">"na"</span><span class="p">,</span>
<span class="s">"stats"</span><span class="p">:</span> <span class="s">"acesEarned: 3, etc..."</span>
<span class="p">},</span>
<span class="s">"relationships"</span><span class="p">:</span> <span class="p">{</span>
<span class="s">"rosters"</span><span class="p">:</span> <span class="p">{</span>
<span class="s">"data"</span><span class="p">:</span> <span class="p">[{</span>
<span class="s">"type"</span><span class="p">:</span> <span class="s">"roster"</span><span class="p">,</span>
<span class="s">"id"</span><span class="p">:</span> <span class="s">"ea77c2eb-d44e-11e6-8f77-0242ac130004"</span>
<span class="p">},</span> <span class="p">{</span>
<span class="s">"type"</span><span class="p">:</span> <span class="s">"roster"</span><span class="p">,</span>
<span class="s">"id"</span><span class="p">:</span> <span class="s">"dc2c14b4-d50c-11e6-bf26-cec0c932ce01"</span>
<span class="p">}]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="get-a-single-match">
<h2>Get a Single Match<a class="headerlink" href="#get-a-single-match" title="Permalink to this headline">¶</a></h2>
<p>This endpoint retrieves a specific match.</p>
<p><strong>HTTP Request</strong>
| <code class="docutils literal"><span class="pre">GET</span> <span class="pre">https://api.dc01.gamelockerapp.com/shards/na/matches/<ID></span></code></p>
<p><strong>URL Parameters</strong>
| Parameter: <code class="docutils literal"><span class="pre">ID</span></code>
| Description: <code class="docutils literal"><span class="pre">The</span> <span class="pre">ID</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">match</span> <span class="pre">to</span> <span class="pre">retrieve</span></code></p>
<p><strong>Shell:</strong></p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>curl <span class="s2">"https://api.dc01.gamelockerapp.com/shards/na/matches/<matchID>"</span> <span class="se">\</span>
-H <span class="s2">"Authorization: Bearer <api-key>"</span> <span class="se">\</span>
-H <span class="s2">"Accept: application/vnd.api+json"</span>
//The above <span class="nb">command</span> returns JSON structured like this:
<span class="o">{</span>
<span class="s2">"data"</span>: <span class="o">{</span>
<span class="s2">"type"</span>: <span class="s2">"match"</span>,
<span class="s2">"id"</span>: <span class="s2">"02b90214-c64d-11e6-9f6b-062445d3d668"</span>,
<span class="s2">"attributes"</span>: <span class="o">{</span>
<span class="s2">"createdAt"</span>: <span class="s2">"2017-01-06T20:30:08Z"</span>,
<span class="s2">"duration"</span>: <span class="m">1482195372</span>,
<span class="s2">"gameMode"</span>: <span class="s2">"casual"</span>,
<span class="s2">"patchVersion"</span>: <span class="s2">"1.0.0"</span>,
<span class="s2">"shardId"</span>: <span class="s2">"na"</span>,
<span class="s2">"stats"</span>: <span class="s2">"acesEarned: 3, etc..."</span>
<span class="o">}</span>,
<span class="s2">"relationships"</span>: <span class="o">{</span>
<span class="s2">"rosters"</span>: <span class="o">{</span>
<span class="s2">"data"</span>: <span class="o">[{</span>
<span class="s2">"type"</span>: <span class="s2">"roster"</span>,
<span class="s2">"id"</span>: <span class="s2">"ea77c2eb-d44e-11e6-8f77-0242ac130004"</span>
<span class="o">}</span>, <span class="o">{</span>
<span class="s2">"type"</span>: <span class="s2">"roster"</span>,
<span class="s2">"id"</span>: <span class="s2">"dc2c14b4-d50c-11e6-bf26-cec0c932ce01"</span>
<span class="o">}]</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
<p><strong>Javascript:</strong></p>
<div class="highlight-Javascript"><div class="highlight"><pre><span></span> <span class="c1">//There are a variety of Java HTTP libraries that support URL parameters</span>
<span class="p">{</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"02b90214-c64d-11e6-9f6b-062445d3d668"</span><span class="p">,</span>
<span class="s2">"attributes"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"createdAt"</span><span class="o">:</span> <span class="s2">"2017-01-06T20:30:08Z"</span><span class="p">,</span>
<span class="s2">"duration"</span><span class="o">:</span> <span class="mi">1482195372</span><span class="p">,</span>
<span class="s2">"gameMode"</span><span class="o">:</span> <span class="s2">"casual"</span><span class="p">,</span>
<span class="s2">"patchVersion"</span><span class="o">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
<span class="s2">"shardId"</span><span class="o">:</span> <span class="s2">"na"</span><span class="p">,</span>
<span class="s2">"stats"</span><span class="o">:</span> <span class="s2">"acesEarned: 3, etc..."</span>
<span class="p">},</span>
<span class="s2">"relationships"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"rosters"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">[{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"roster"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"ea77c2eb-d44e-11e6-8f77-0242ac130004"</span>
<span class="p">},</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"roster"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"dc2c14b4-d50c-11e6-bf26-cec0c932ce01"</span>
<span class="p">}]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../datacenters/datacenters.html">Datacenters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../authorization/authorization.html">Authorization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../titles/titles.html">Titles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../makingrequests/makingrequests.html">Making Requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../receivingresponses/receivingresponses.html">Receiving Responses</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Matches</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#rosters">Rosters</a></li>
<li class="toctree-l2"><a class="reference internal" href="#participants">Participants</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-a-collection-of-matches">Get a Collection of Matches</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-a-single-match">Get a Single Match</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../match_data_summary/match_data_summary.html">Match Data Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../players/players.html">Players</a></li>
<li class="toctree-l1"><a class="reference internal" href="../samples/samples.html">Samples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../telemetry/telemetry.html">Telemetry</a></li>
<li class="toctree-l1"><a class="reference internal" href="../teams/teams.html">Teams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../links/links.html">Links</a></li>
<li class="toctree-l1"><a class="reference internal" href="../community_sdks/community_sdks.html">Community SDKs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../errors/errors.html">Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog/changelog.html">Changelog</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="../receivingresponses/receivingresponses.html" title="Previous document">Receiving Responses</a>
</li>
<li>
<a href="../match_data_summary/match_data_summary.html" title="Next document">Match Data Summary</a>
→
</li>
</ul>
</nav>
<nav id="breadcrumbs">
<ul>
<li><a href="../index.html">Battelrite 0.2 documentation</a></li>
</ul>
</nav>
</div>
</body>
</html>
|
