Ko-fi

Get Ko-fi shop item

Get a Ko-fi shop item with its full description, images, contents, stock and seller.

GET/v1/ko-fi/shop-items/{alias}
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
1
aliasstringrequiredpath

Shop item alias from `https://ko-fi.com/s/{alias}`.

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

Response fields
43

Endpoint-specific response payload.

datalookupStatus
string

Whether the requested entity exists.

one of: found, not_found

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

dataitemid
stringnullable

Item id (GUID).

dataitemalias
string

Alias used in `/s/{alias}`.

dataitemurl
string

Public item URL.

dataitemname
string

Item name.

dataitemdescription
stringnullable

Full description.

dataitemprice
numbernullable

Price.

≥ 0

dataitemcurrency
stringnullable

Currency code.

Image URLs.

dataitemimages[]
stringoptional
dataitempayWhatYouWant
boolean

Whether the buyer chooses the price.

dataitemsoldOut
boolean

Whether the item is sold out.

dataitemsoldText
stringnullable

The sold line as Ko-fi displays it, e.g. `21.5K sold`.

dataitemstockText
stringnullable

The stock line as Ko-fi displays it, e.g. `Only 1 left!`.

dataitemstockRemaining
integernullable

Parsed remaining stock.

≥ 0

dataitemunlocksContent
boolean

Whether buying unlocks content.

dataitemmaxQuantity
integernullable

Maximum quantity per order.

≥ 0

Published destinations; empty when the item lists only a worldwide fee or no destinations.

dataitemshipsTo[]
stringoptional

Published shipping fees with the item's default destination first, then any additional rows; empty when no fee is published.

dataitemshippingFees[]country
string

Destination country or region.

dataitemshippingFees[]fee
number

Shipping fee in the item's currency; 0 when it is free.

≥ 0

Shop category ids.

dataitemcategories[]
integeroptional
dataitemdiscountPercent
numbernullable

Discount percent.

≥ 0

The `what's included` lines.

dataitemcontents[]
stringoptional

Variations; empty when none.

dataitemvariations[]id
stringnullable

Variation id.

dataitemvariations[]name
stringnullable

Variation name, e.g. `Blue Elephant`.

dataitemvariations[]order
integernullable

Display order the seller set; rows are returned by it.

dataitemvariations[]itemsAvailable
integernullable

Remaining stock for the variation.

dataitemvariations[]costNormalized
numbernullable

Variation price.

dataitemvariations[]previewIndex
integernullable

Index of the image this variation shows.

Who sells the item.

dataitemsellerid
stringnullable

Seller page id.

dataitemsellername
stringnullable

Seller display name.

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/shop-items/25d06ddd2a" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Get a Ko-fi shop item.