Summarise your inventory

​

Returns the totals of your inventory in one call: the whole collection, the part that is for sale with its asking value, the part that is not, and a breakdown per game.

Market values are quantity multiplied by market price, in EUR for EU market prices and in USD for NA ones; a line without a market price counts as 0, and unpricedCards says how many cards that is. Two calls a minute apart can differ when you edit your inventory. A summary that cannot be computed in time returns 503 SEARCH_UNAVAILABLE, never partial totals.

Send game to restrict the totals to one game.

Requires the inventory:read scope.

Query Parameters

  • game
    Type: string

    Restricts every total to one game, by slug (e.g. pokemon, mtg, ygo). Leave it out for all games.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/inventory/summary
curl https://public-api.cardnexus.com/v1/inventory/summary \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "collection": {
    "lines": 18420,
    "cards": 61230,
    "marketValue": {
      "eu": {
        "amount": 48210.55,
        "currency": "EUR"
      },
      "na": {
        "amount": 52980.1,
        "currency": "USD"
      }
    },
    "unpricedCards": {
      "eu": 412,
      "na": 398
    }
  },
  "listed": {
    "lines": 12430,
    "cards": 40115,
    "marketValue": {
      "eu": {
        "amount": 33120.4,
        "currency": "EUR"
      },
      "na": {
        "amount": 36402.75,
        "currency": "USD"
      }
    },
    "askingValue": [
      {
        "amount": 35840.2,
        "currency": "EUR"
      }
    ]
  },
  "unlisted": {
    "lines": 5990,
    "cards": 21115,
    "marketValue": {
      "eu": {
        "amount": 15090.15,
        "currency": "EUR"
      },
      "na": {
        "amount": 16577.35,
        "currency": "USD"
      }
    }
  },
  "games": [
    {
      "game": "pokemon",
      "name": "Pokémon",
      "lines": 9320,
      "cards": 31100,
      "listedLines": 6100,
      "listedCards": 20400,
      "marketValue": {
        "eu": {
          "amount": 29770,
          "currency": "EUR"
        },
        "na": {
          "amount": 32410,
          "currency": "USD"
        }
      },
      "unpricedCards": {
        "eu": 120,
        "na": 118
      }
    }
  ],
  "webUrl": "https://cardnexus.com/users/north_arena_tcg/dashboard"
}

Summary returned.

Previous
Search your inventory
Next
Read the value history of your inventory