API Reference (Preview)

SOCI4L is primarily a product rather than a public API, but some read‑only endpoints can already be used for lightweight integrations. This page describes the current status and expectations.

Stability expectations

At the time of writing:

• There is no officially versioned public API.
• Routes and response shapes may change between releases without prior notice.
• Any external integration should treat the API as best‑effort rather than a hard contract.

For long‑term, strongly typed integrations, see the SDK roadmap docs.

Typical read‑only use cases

Even without a formal API, you can often:

• Fetch basic public profile data (display name, slug, avatar, score, links).
• Retrieve public insights such as total views or top links for a profile.
• Look up donation history or Premium purchases associated with a wallet.

These endpoints are the same ones the web app uses internally; you can inspect them via your browser’s network tools if you are comfortable doing so.

Guidelines for explorers and builders

If you experiment with the unofficial API:

• Prefer GET requests against clearly read‑only routes.
• Cache responses conservatively; do not hammer the API with high‑frequency polling.
• Be prepared for breaking changes and handle errors gracefully.

When the API surface stabilises, we plan to:

• Publish a dedicated, versioned API Reference with path, parameters and schemas.
• Ship a small SDK that wraps these endpoints with typed helpers.

Until then, treat this page as a high‑level note rather than a strict contract.