Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Itch.io Wharf API

Wharf build infrastructure operations (butler/CI integration)

Itch.io Wharf API is one of 11 APIs that Itch.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Wharf. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 10 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.itch.io.

12 operations 10 paths 20 schemas 6 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.itch.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Itch.io Wharf API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key or JWT token issued by itch.io

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 6 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Wharf 12

Wharf build infrastructure operations (butler/CI integration)

GET
/wharf/status
Wharf status
wharfStatus → 200
GET
/wharf/channels
List wharf channels
listChannels 1 param → 200401
GET
/wharf/channels/{channelName}
Get wharf channel
getChannel 2 params → 200401
POST
/wharf/builds
Create wharf build
createBuild body → 200401
GET
/wharf/builds/{buildId}
Get wharf build
getWharfBuild 1 param → 200401404
GET
/wharf/builds/{buildId}/files
List build files
listBuildFiles 1 param → 200401
POST
/wharf/builds/{buildId}/files
Create build file
createBuildFile 1 param body → 200401
POST
/wharf/builds/{buildId}/files/{fileId}
Finalize build file
finalizeBuildFile 2 params body → 200401
GET
/wharf/builds/{buildId}/events
List build events
listBuildEvents 1 param → 200401
POST
/wharf/builds/{buildId}/events
Create build event
createBuildEvent 1 param body → 200401
POST
/wharf/builds/{buildId}/failures
Mark build as failed
createBuildFailure 1 param body → 200401
POST
/wharf/builds/{buildId}/failures/rediff
Mark build rediff as failed
createRediffBuildFailure 1 param body → 200401

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Game (23 properties), Upload (15 properties), Build (14 properties), User (8 properties). Each schema is shown below with its type and property counts.

BuildFile
object
Contains information about a build file (archive, signature, patch, etc.)
7 properties
Build
object
Contains information about a specific build
14 properties
ErrorResponse
object
1 property
CreateBuildFileResponse
object
1 property
FileUploadSpec
object
Contains the info needed to upload one specific build file
4 properties
Sale
object
Describes a discount for a game
5 properties
ListBuildEventsResponse
object
1 property
Upload
object
A downloadable file; may be wharf-enabled for versioned channel-based distribution
15 properties
GameEmbedData
object
Presentation information for embed games
4 properties
Game
object
Represents a page on itch.io; could be a game, tool, comic, etc.
23 properties
Platforms
object
Describes which OS/architectures a game or upload is compatible with
3 properties
ListChannelsResponse
object
1 property
User
object
Represents an itch.io account with basic profile info
8 properties
GetWharfBuildResponse
object
1 property
Channel
object
Contains information about a channel and its current status
5 properties
GetChannelResponse
object
1 property
ListBuildFilesResponse
object
1 property
BuildEvent
object
Describes something that happened while processing a build
3 properties
CreateBuildResponse
object
1 property
WharfStatusResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

itch-io-wharf-api-openapi.yml Raw ↑

Other APIs Itch.io publishes across the network.

Itch.io Auth API
Itch.io Builds API
Itch.io Bundles API
Itch.io Collections API
Itch.io Downloads API
Itch.io Games API
Itch.io Profile API
Itch.io Search API
Itch.io Uploads API
Itch.io Users API