XFlux

Quickstart

Get from zero to your first API response in a few minutes.

1. Create an account

Register for a free account. No credit card required on the Free plan. A default API key is created automatically — you'll see it once on the Dashboard after signup.

2. Make your first API call

After signup you'll land on a welcome screen — click Run test call to look up @elonmusk (no curl needed). Or use curl with your key:

curl -X GET "https://www.xfluxapi.com/api/v1/users/elonmusk" \
  -H "Authorization: Bearer xflux_YOUR_KEY"

3. Save your API key

Copy the key from the welcome screen right after signup — it won't be shown again. Keys are prefixed with xflux_. Need a new one? Dashboard → API Keys → Create key.

Registration creates a Default API key automatically. You do not need to create one manually before your first call.

4. (Optional) Add a monitor

In Dashboard → Monitors, add @username. Click Check now to run the first poll (baseline only). New tweets after that appear as hits.

Next steps