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

Profile

View .md

Endpoints for profile images and pins.

BASE URL https://micro.blog
GET /users/pins/{username}

Returns the pins for your own account, unlocked or not. Pins can only be read for the signed-in user; any other username returns 404 with User not sharing pins. An unknown username returns 404 with User not found.

Example Request

curl -X GET "https://micro.blog/users/pins/{username}" \
  --header "Authorization: Bearer ABCDEF1234567890ABCD"

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Path Parameters

Name Type Required Description
username string Required Your Micro.blog username.
Example: vincent

Response

200 OK application/json

Returns an array of pins. Locked pins show how to unlock them and use a placeholder icon. Pins that can no longer be earned are listed only if you unlocked them.

Example Response

[
  {
    "title": "Welcome",
    "description": "You registered a username. Thanks for joining.",
    "icon": "https://micro.blog/images/pins/welcome.png",
    "is_unlocked": true
  },
  {
    "title": "10 Posts",
    "description": "Unlock this pin by posting 10 times.",
    "icon": "https://micro.blog/images/pins/pending.png",
    "is_unlocked": false
  }
]
GET /{username}/avatar.jpg

Returns a user’s profile photo. No authentication is required. Returns 404 if the user does not exist.

Example Request

curl -L -X GET "https://micro.blog/{username}/avatar.jpg" --output avatar.jpg

Path Parameters

Name Type Required Description
username string Required Micro.blog username.
Example: vincent

Response

200 OK image/jpeg

Returns the uploaded profile photo as a JPEG, cacheable for two hours. Users without an uploaded photo get a 302 redirect to their external avatar, Gravatar, or a blank placeholder image.

GET /{username}/favicon.png

Returns the favicon a user set for their blog. No authentication is required. Returns 404 if the user does not exist.

Example Request

curl -L -X GET "https://micro.blog/{username}/favicon.png" --output favicon.png

Path Parameters

Name Type Required Description
username string Required Micro.blog username.
Example: vincent

Response

200 OK image/png

Returns the favicon as a PNG. Users without a custom favicon get a 302 redirect to /{username}/avatar.jpg.

GET /{username}/podcast.png

Returns a user’s podcast artwork. No authentication is required. Returns 404 if the user does not exist.

Example Request

curl -L -X GET "https://micro.blog/{username}/podcast.png" --output podcast.png

Path Parameters

Name Type Required Description
username string Required Micro.blog username.
Example: vincent

Response

200 OK image/png

Returns the podcast artwork as a PNG. Users without custom artwork get a 302 redirect to /{username}/avatar.jpg.