Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
  • Home
  • Sky's The Limit - Cloud9 x JetBrains Hackathon

How do I use the File Download API?

Article 3619453, Status: VALIDATED

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Client Help
  • Sky's The Limit - Cloud9 x JetBrains Hackathon
+ More

Table of Contents

❓Issue/Question 💻Environment/Context 👌Resolution/Answer

❓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:

  1. Input your API key into the headers section. The API uses x-api-key authentication
  2. First you need to call the File Download List endpoint
    1. Input this as the GET endpoint: https://api.grid.gg/file-download/list/2692648
  3. 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"
            }
        ]
    }        
  4. You extract the fullURL to then download the file that you need. We will use the events-grid as the example. 
  5. Use the GET function with https://api.grid.gg/file-download/events/grid/series/2692648
  6. The file will be downloaded so you can examine it

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • How do I use the Central Data API?
  • What is the Central Data API?
  • How do I use the Series State API?
Privacy Policy
Esports Players Privacy Notice
Imprint
Careers
GRID® 2022 | All Rights Reserved
Expand