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
|
# Receiving Responses
## Payload
All Server responses contain a root JSON object.
```jsonjson
{
"data": {
"type": "match",
"id": "skarn",
"attributes": {
// ... this matches attributes
},
"relationships": {
// ... this matches relationships
}
}
}
```
```json
{
"data": {
"type": "match",
"id": "1"
}
}
```
A response will contain at least one of the following top-level members:
* `data`: the response's “primary data”
* `errors`: an array of error objects
A response may contain any of these top-level members:
* `links`: a links object related to the primary data.
* `included`: an array of resource objects that are related to the primary data and/or each other (“included resources”).
If a document does not contain a top-level data key, the included member will not be present either.
Primary data will be either:
* a single [resource object][resource objects], a single [resource identifier object], or `null`
* an array of [resource objects], an array of [resource identifier objects][resource identifier object], or
an empty array (`[]`)
For example, the following primary data is a single resource object:
The following primary data is a single [resource identifier object] that
references the same resource:
A logical collection of resources will always be represented as an array, even if
it only contains one item or is empty.
## Rate Limits
>The rate limit headers are defined as follows:
```
X-RateLimit-Limit - Request limit per day / per minute
X-RateLimit-Remaining - The number of requests left for the time window
X-RateLimit-Reset - The remaining window before the rate limit is refilled in UTC epoch nanoseconds.
* Limit tokens are incrementally filled by 60(sec)/ rate limit. ex: 60(sec)/10(rate) gets rate token every 6 seconds up to max rate limit.
```
Be nice. If you're sending too many requests too quickly, we'll send back a
`429` error code (server unavailable).
<aside class="notice">
Free for non-commercial use for up to 10 requests per minute! To increase your rate limit, please contact api@superevilmegacorp.com
</aside>
|
