iPX
API ipx-directory 1.0.0
The HTTP API of the directory of public podcasts that iPX servers share, at
https://directory.ipxreader.app/v1. Its pages at directory.ipxreader.app are anyone’s
to browse; the API needs a token for everything.
Tokens
Authorization: Bearer <token>A token has a name and one of three levels of access: ro reads,
rw also shares, and rwa also removes and blocks feeds and drops a
server’s share. Tokens are given out by whoever runs the directory, and none can be made or
revoked over the API.
Errors
A request that fails answers with its status and {"error": "…"}:
401 no token or an unknown one, 403 a token without the access,
404 not listed.
Ids
A feed’s id is the first 16 hex digits of the SHA-256 of its address with the
scheme and host in lower case and no default port or fragment, so every server arrives at the
same one. Descriptions are the publisher’s own HTML, unsanitized: sanitize them before you
show them.
Modules
- feeds
- What the directory lists.
- share
- A server telling the directory what its people follow.
- admin
- Removing and blocking feeds, and the servers sharing.
rwatokens only.
Types
- Me
- A token, as the directory knows it.
- Access
- A token’s access:
"ro","rw"or"rwa". - Limit
- A query parameter.
- Listing
- A feed listed.
- FeedPage
- A feed’s page: every field of
Listing, and these. - Item
- An episode or post. Never its file.
- SnapshotEntry
- One feed in a share.
- SnapshotResult
- What the directory made of a share.
- Blocked
- Instance