Attribution

šŸ“˜

Why Attribution?

Hundreds of man hours have gone into curating and providing this information into easy-to-use APIs. As such, we simply ask for attribution in return so others can utilize these services in their projects, as well as help promote the HITMAPS name.

HITMAPS.com provides these services free-of-charge. However, in return for using our services, you must provide some sort of attribution on your site / project that is visible to all users when using your application / website (i.e. not hidden away in a file nested in 47 folders that no one looks in).

Some acceptable forms of attribution:

  • "Data retrieved by HITMAPS"
  • "Information powered by {HITMAPS logo}"

Please ensure that the HITMAPS name and/or logo follows the brand guidelines in your attribution.

All public endpoints currently do not require any sort of authentication. However, this may change in the future.

Versioning

These APIs are versioned. You may specify a specific API version by using the X-API-Version header. Consult specific API documentation for which versions are available. Omitting this header will result in the newest version being consumed.

Dates

If an endpoint returns a date, it will be returned in ISO-8601 format, such as 2019-04-08T12:51:00+00:00. All dates and times will be in UTC.

Errors

All endpoints, when successful, will return a 200 OK response. Below are the generic error responses. Any specific error responses are indicated at the appropriate API documentation.

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
    "title": "Looking up contract / leaderboard for 2-29-5415134-58 on PlayStation failed.",
    "status": 500,
    "traceId": "00-9e49a8b6829881fbb38270ddd59de755-1ac154b8005614d4-00"
}