View on GitHub

Documentation and sample code

Getting Start

Login and go to the Settings menu at Gameflip.com. Here you can either create your API Key and TOTP secret or request to have Developer access. Please specify how you intend to use the platform. Due to limited support, we only accept a small number of developers during the Beta period. We will open up the developer access over time.

Sample Code

API Request

All API requests must provide an Authorization header:

Authorization: GFAPI <apikey>:<totp>

To get the API Key and secret, contact Gameflip support. During Beta, API Keys are only being given out to select customers.

Sample code to generate the Authorization header

API Response

For http methods that support a response body, the API always responds with a json document which contains at least the status field. Other fields follow in the data section which can be an array of similar objects or a single object.

sample response: single object

{
  "status": "SUCCESS",
  "data": { "id": "... listing data object as defined in Listing.md ..." }
}

sample response: list of objects

{
  "status": "SUCCESS",
  "data": [
    { "id": "... listing data object 1 as defined in Listing.md ..." },
    { "id": "... listing data object 2 as defined in Listing.md ..." }
  ]
}

sample response: failure message

{
  "status": "FAILURE",
  "data": null,
  "error": {
    "message": "error message",
    "code": 400
  }
}

Service: Profile

Service Method Documentation
/api/v1/account/:id/profile GET GET /api/v1/account/:id/profile
/api/v1/account/me/profile GET GET /api/v1/account/me/profile

Service: Account

Service Method Documentation
/api/v1/account/me/wallet_history GET GET /api/v1/account/me/wallet_history

Service: Listing

The listing service is used to create and manipulate listing of items for sale. A listing is represented as a JSON document which is defined in the Listing document.

Listings can have zero or more photos associated with them.

Service Method Documentation
/api/v1/listing GET GET /api/v1/listing
/api/v1/listing POST POST /api/v1/listing
/api/v1/listing/:id GET GET /api/v1/listing/:id
/api/v1/listing/:id PATCH PATCH /api/v1/listing/:id
/api/v1/listing/:id DELETE DELETE /api/v1/listing/:id
/api/v1/listing/:id/photo POST POST /api/v1/listing/:id/photo

Service: Exchange

The exchange service creates and manages sell-buy records. A exchange is represented as a JSON document which is defined in the Exchange document.

Exchanges can have zero or more sources associated with them.

Service Method Documentation
/api/v1/exchange POST POST /api/v1/exchange

Service: Steam Escrow

The escrow service is used to escrow Steam items.

Service Method Documentation
/api/v1/steam/escrow/hold GET GET /api/v1/steam/escrow/hold
/api/v1/steam/escrow/mine GET GET /api/v1/steam/escrow/mine
/api/v1/steam/escrow/:id GET GET /api/v1/steam/escrow/:id

Service: Steam Bulk

The bulk service allows you to create listings/escrow for multiple Steam items with one trade offer.

Service Method Documentation
/api/v1/steam/bulk/mine GET GET /api/v1/steam/bulk/mine
/api/v1/steam/bulk POST POST /api/v1/steam/bulk
/api/v1/steam/bulk/:id PUT PUT /api/v1/steam/bulk/:id
/api/v1/steam/bulk/:id GET GET /api/v1/steam/bulk/:id