Lux

Quickstart

This guide will get you all set up and ready to use the Lux API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API for creating multiplayer internet experiences.

Before you can make requests to the Lux API, you will need to grab your API key from your developer dashboard. You can find it under Settings » API Keys.

Choose your client

Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, Lux offers clients for JavaScript, Python, and PHP. In the following example, you can see how to install each client.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

After picking your preferred client, you are ready to make your first call to the Lux API. Below, you can see how to send a GET request to the Spaces endpoint to get a list of all shared spaces your user has joined. In the cURL example, results are limited to ten spaces, the default page length for each client.

GET
/v1/stations
curl -G https://api.lux.gg/v1/stations \
  -H "Authorization: {token}" \
  -d limit=10

Read the docs for the Stations endpoint

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Lux API to build multiplayer web experiences:

Was this page helpful?