How do I use the File Download API?
Article 3619453, Status: VALIDATED
Table of Contents
❓Issue/Question
- How do I use the File Download API?
💻Environment/Context
- Sky's The Limit - Cloud9 x JetBrains Hackathon
👌Resolution/Answer
- Full File Download Documentation is available here and the API reference here
-
IMPORTANT: The File Download API is using a different base URL:
https://api.grid.gg - You can test it using any API testing tools such as Postman, Insomnia, Bruno and others
Quick how-to:
- Input your API key into the headers section. The API uses
x-api-keyauthentication - First you need to call the File Download List endpoint
- Input this as the GET endpoint:
https://api.grid.gg/file-download/list/2692648
- Input this as the GET endpoint:
- This will return the list of available files
{ "files": [ { "id": "events-grid", "description": "Grid Series Events (.jsonl)", "status": "ready", "fileName": "events_2692648_grid.jsonl.zip", "fullURL": "https://api.grid.gg/file-download/events/grid/series/2692648" }, { "id": "state-grid", "description": "Grid Post Series State (.json)", "status": "ready", "fileName": "end_state_2692648_grid.json", "fullURL": "https://api.grid.gg/file-download/end-state/grid/series/2692648" } ] } - You extract the
fullURLto then download the file that you need. We will use theevents-gridas the example. - Use the GET function with
https://api.grid.gg/file-download/events/grid/series/2692648 - The file will be downloaded so you can examine it