API Reference

RESTful JSON API. All endpoints require authentication and count against your monthly API quota.

Authentication

Pass your API key via Bearer token or X-API-Key header.

Authorization: Bearer xflux_YOUR_API_KEY
# or
X-API-Key: xflux_YOUR_API_KEY

Base URL

https://xfluxapi.com/api/v1

Endpoints

{ "text": "Hello from XFlux!" }

Response format

Successful responses return JSON with a data field. Errors return error and HTTP 4xx/5xx.

{
  "data": {
    "id": "44196397",
    "username": "elonmusk",
    "name": "Elon Musk",
    "followers_count": 000000,
    "verified": true
  }
}

Examples

# User profile
curl "https://xfluxapi.com/api/v1/users/elonmusk" \
  -H "Authorization: Bearer xflux_YOUR_KEY"

# User timeline
curl "https://xfluxapi.com/api/v1/users/elonmusk/tweets?limit=10" \
  -H "Authorization: Bearer xflux_YOUR_KEY"

# Search
curl "https://xfluxapi.com/api/v1/search?q=bitcoin&limit=20" \
  -H "Authorization: Bearer xflux_YOUR_KEY"