Server API

The Blux Server API lets a trusted backend interact with a project directly. Use it to retrieve project users, search for a user, remove a user, or verify that a wallet address really belongs to someone who signed in to your project through Blux.

These endpoints are independent of @bluxcc/react and @bluxcc/core. They are ordinary HTTPS endpoints and can be called from any backend language or framework.

Base URL

https://api.blux.cc

All requests and responses use JSON. Successful responses use either a message field or a message and result envelope. Errors use an error field.

Quick start

Copy your project's App ID and App Secret from the Blux Dashboard, store them in your backend's secret manager or private environment, and send them as request headers:

curl --request GET \
  --url 'https://api.blux.cc/server/users?limit=20' \
  --header "blux-app-id: $BLUX_APP_ID" \
  --header "blux-app-secret: $BLUX_APP_SECRET"

The same request with Node.js:

const response = await fetch("https://api.blux.cc/server/users?limit=20", {
  headers: {
    "blux-app-id": process.env.BLUX_APP_ID!,
    "blux-app-secret": process.env.BLUX_APP_SECRET!,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Blux API error (${response.status}): ${error}`);
}

const { result } = await response.json();
console.log(result.users);

Routes

For the live machine-readable contract, see the server section in Swagger.