Ko-fi

Get Ko-fi album

Get one public Ko-fi album with its gallery tiles, 15 a page.

GET/v1/ko-fi/albums/{slug}
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
2
slugstringrequiredpath

Album slug from `/album/{slug}`, e.g. `Belle-Cards-Y8Y616PKXL`.

min 1 chars · max 200 chars · pattern: ^[A-Za-z0-9_-]+$

cursorstringoptionalquery

Cursor from `page.nextCursor` of the previous response. It only works with the same filters.

min 1 chars · max 2048 chars

Response fields
27

Endpoint-specific response payload.

datalookupStatus
string

Whether the requested entity exists.

one of: found, not_found

The album when `lookupStatus` is `found`; otherwise null.

dataalbumid
string

Album id from the slug's last segment.

dataalbumslug
string

Album slug from `/album/{slug}`.

dataalbumtitle
stringnullable

Album title.

dataalbumurl
string

Public album URL.

Gallery tiles in the album, 15 a page; empty when the album has no public items.

dataalbumitems[]id
string

Gallery item id.

dataalbumitems[]title
stringnullable

Tile title.

Tile image; null for a locked tile, which shows only a placeholder.

dataalbumitems[]imageurl
string

Image URL.

dataalbumitems[]imagealt
stringnullable

Image alt text.

dataalbumitems[]access
string

`restricted` when the tile is locked.

one of: public, restricted

dataalbumitems[]imageCount
integer

Number of images in the item; 1 when the tile has no multi-image badge.

≥ 1

Pagination state for the current page.

datapagepage
integernullable

Zero-based page index for a numbered list; null for offset lists.

≥ 0

datapagestart
integernullable

Offset of this page for an offset list; null for numbered lists.

≥ 0

datapagereturned
integer

Number of rows in this response.

≥ 0

datapagehasMore
boolean

Whether another page is available.

datapagenextPage
integernullable

Next page index for a numbered list; null when there is none.

≥ 0

datapagenextCursor
stringnullable

Cursor for the next page; null on the last page.

datapagetotal
integernullable

Total rows when Ko-fi publishes one (comments: all comments including replies); otherwise null.

≥ 0

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/ko-fi/albums/Belle-Cards-Y8Y616PKXL" \
  -H "x-api-key: YOUR_API_KEY"

Responses

A Ko-fi album and its gallery tiles.