Build with Micro.blog logo
Build with Micro.blog
API Documentation

Microsub

View .md

Microsub endpoints for channels, timelines, and follow actions.

BASE URL https://micro.blog
GET /microsub

Handles Microsub channel and timeline queries.

Example Request

curl -X GET "https://micro.blog/microsub?action=timeline"

Query Parameters

Name Type Required Description
action string Required Microsub action.
Example: timeline
channel string Optional Microsub channel identifier.
Example: default
before string Optional Microsub pagination cursor for older items.
Example: 12345
after string Optional Microsub pagination cursor for newer items.
Example: 67890

Response

200 OK application/json

Returns a JSON response.

Example Response

{
  "items": [
    {
      "type": "entry",
      "published": "2026-04-26T12:00:00+00:00",
      "content": {
        "html": "<p>Hello from Micro.blog.</p>"
      },
      "url": "https://example.com/post",
      "author": {
        "type": "card",
        "name": "Vincent",
        "url": "https://vincent.micro.blog/",
        "photo": "https://avatars.micro.blog/avatars/2025/39/3008.jpg"
      },
      "_id": "12345"
    }
  ],
  "paging": {
    "before": "12345"
  }
}
POST /microsub

Handles Microsub write actions such as follow.

Example Request

curl -X POST "https://micro.blog/microsub?action=timeline"

Query Parameters

Name Type Required Description
action string Required Microsub action.
Example: timeline
channel string Optional Microsub channel identifier.
Example: default
url string Optional URL for the target resource.
Example: https://example.com/post
username string Optional Micro.blog username.
Example: vincent

Response

200 OK application/json

Returns an empty JSON object on success.

Example Response

{}