PixelEast API

The PixelEast API gives creators programmatic access to their account. Things you manage in the creator dashboard become callable from your own scripts, build pipelines and tools. This page covers how to get access, how tokens and their abilities work, and the rules and limits that apply to every integration.

What the API can do

It is a standard REST API that uses JSON over HTTPS. Everything happens on behalf of the account that owns the token and follows the same rules the dashboard enforces, so an integration can never do anything you could not do yourself by hand. Here are a few of the things creators build with it.

Who can use it

Creating API tokens is part of the Premium creator plan. Without an active plan the token form in the dashboard stays locked. With an active plan you can create tokens right away and everything on this page applies.

A token always acts as the account that created it. It sees that account's products, sales, customers and finances, and nothing belonging to anyone else. There are no shared or team tokens. If a tool should work with your products, it needs a token from your account.

Create your first token

1. 1

   Open the API Overview page in your creator dashboard.

2. 2

   Give the token a name that says which tool it belongs to, for example release-pipeline or stats-widget, and tick only the abilities that tool needs.

3. 3

   Create it and copy the token straight away. For security it is shown in full only this once. If you lose it, there is nothing to recover, so revoke it and create a new one.

Token abilities

Every token carries a set of abilities that decides which endpoints it may call. You pick them when you create the token and they cannot be changed afterwards, only replaced by a new token. There are four, and you can combine them freely.

A call outside the token's abilities is refused with 403 Forbidden. Give each integration only what it needs. A stats widget only needs read, while a release pipeline typically needs read, create and update. It is better to create several narrow tokens than one token that can do everything.

Limits, expiry and revoking

• You can hold up to 10 active tokens at a time, enough for one token per tool.
• Each token is valid for one year from the day it is created. After that it stops working and you create a fresh one.
• You can revoke any token at any time from the API Overview page, which also shows when and from which IP addresses each token was last used. Revoking takes effect immediately.

Base URL, authentication and format

Every endpoint lives under https://api.pixeleast.com/v1. Responses are always JSON. Requests are JSON too, except for file uploads such as version files, cover and gallery images, which are sent as multipart form data. You authenticate by sending your token as a bearer token in the Authorization header. The quickest way to check that everything works is a call to the profile endpoint.

curl "https://api.pixeleast.com/v1/me" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

This returns the profile of the account behind the token, including the username, creator and Premium status, the balances and when the account was created. If you get 401 Unauthorized instead, the token is missing, mistyped, expired or revoked.

Rate limits

The API allows 30 requests per minute per account, counted across every endpoint and all of your tokens together. If you go over the limit, requests are refused with 429 Too Many Requests until the next minute starts, and the response carries a Retry-After header telling you how long to wait.

For bulk work, spread your requests out instead of sending them all at once, and use per_page (up to 100 items) on list endpoints to fetch more data with fewer requests.

The full endpoint reference

This page only covers the basics. The complete and always up-to-date reference lives in the API Documentation section of your creator dashboard, where every endpoint is grouped by category and searchable, each with its parameters, an example request and an example response you can copy straight into your tooling.

The Getting Started tab there covers the same basics as this page, so you will find everything in one place once you are signed in to the dashboard.