youring · api v1RU / EN

The ring API, open

JSON, no keys and no registration. Cached 60s, soft limits. Full schema — /openapi.json (OpenAPI 3.1).

The ring

GET/api/v1/ring

The whole ring: active sites in ring order.

GET/api/v1/ring/{slug}

A site and its neighbours: site, prev, next, index, total.

GET/api/v1/ring/{slug}/next|prev|random

A single neighbour. Handy for navigation.

GET/api/v1/ring/opml

OPML bundle: one subscription for every ring feed (RSS/Atom).

Search

GET/api/v1/random?exclude=slug

A random member. ?kind= narrows it to a sub-ring.

GET/api/v1/search?q=code&limit=10

Search by name, domain, description and tags.

Numbers and health

GET/api/v1/stats

Members, pending, new this week, clicks.

GET/api/v1/health

Member grades: online 40 · widget 30 · links 15 · profile 15 → S...F.

Widget, badge, redirects

GET/{slug}

302 to the member site, counts the click.

GET/{slug}/prev · /{slug}/next · /{slug}/random

302 to a neighbour — for buttons on your site.

GET/badge/{slug}.svg

SVG badge with the name and arrows.

GET/widget.js

Web component <youring-ring>.

Example

curl https://youring.roxera.net/api/v1/ring/xxiivv

{
  "site": { "slug": "xxiivv", "name": "XXIIVV", ... },
  "index": 0, "total": 8,
  "prev": { "slug": "...", "name": "..." },
  "next": { "slug": "...", "name": "..." }
}

Widget generator

Paste your site slug to get ready-made code.


  
the preview appears here