MKM API

API Documentation >> API 2.0 Main >> Stock Management >> Stock (File)

Stock (File)

Allowed HTTP Methods

GET - Returns a gzipped CSV file with all articles in the authenticated user's stock, further specified by a game, language, and type of articles (single cards or sealed products).

Resource Information

Authentication - Required
Response Format - XML or JSON
Response Object - see below
API Version - 2.0
Resource URI - https://api.cardmarket.com/ws/v2.0/stock/file

Parameters

idGame (query parameter)
- Specifies the Game the stock file is for
- Type: integer
- Optional (default is 1 for Magic the Gathering)
isSealed (query parameter)
- Specifies if sealed product should be returned
- Type: boolean (true|false)
- Optional (default is false for retrieving single cards)
idLanguage (query parameter)
- Specifies the Language of the Local Name column in the resulting file
- Type: integer
- Optional (default is 1 for English)

Response Object

Stock File Entity

{
    stock:          // The base64 encoded string
    mime:           // The MIME type of the file
    links:          // HATEOAS links
}

The response object and the relevant stock contains a string which is Base64 encoded. Decoding it returns a binary string that has to be written to an empty file. This file is gzipped and finally needs to be unpacked to retrieve the CSV file having the following columns:

idProduct - The product ID of the article
English Name - The English name of the article
Local Name - The localized name specified by the idLanguage query parameter
Exp. - The abbreviation for the expansion the product belongs to
Price - The price the article is listed for
Language - The language of the article
isAttribute - Number of additional attribute fields depending on the game the article is from
comments - Own comment for the article
amount - number of listed articles

Example Request

1. Downloading single cards in stock for Magic with Local Name column values set to English names (Default idGame=1, isSealed=false idLanguage=1)

GET https://api.cardmarket.com/ws/v2.0/stock/file

2. Downloading sealed products in stock for YGO with Local Name column values set to German names

GET https://api.cardmarket.com/ws/v2.0/stock/file?idGame=3&isSealed=true&idLanguage=3

3. Downloading non game related Accessories stock (isSealed must be true or code 429 is returned).

GET <https://api.cardmarket.com/ws/v2.0/stock/file?idGame=99&isSealed=true

Contents