extractr docs
TCGPlayer

Identify a card from an image

POST
/tcgplayer/scan

Recognise a card from a photo (base64-encoded) and return the matching catalog products. The best match links straight to its tcgplayer_id.

Costs 5 credits per request.

Authorization

ApiKeyAuth
X-API-Key<token>

API key created in the extractr dashboard (ext_live_...). Also accepted as Authorization: Bearer.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/tcgplayer/scan" \  -H "Content-Type: application/json" \  -d '{    "image_base64": "string"  }'
{  "matched": true,  "best_match": {    "tcgplayer_id": "659612",    "name": "Mega Charizard X ex",    "category": "Pokemon",    "category_id": "3",    "set": "Mega Evolution Promos",    "set_id": "24451",    "card_number": "023",    "rarity": "Promo",    "sub_type": "Holofoil",    "is_card": true,    "image": "https://tcgplayer-cdn.tcgplayer.com/product/659612_in_1000x1000.jpg",    "market_price": 37.63,    "price_change": 0.03,    "price_change_pct": 0.08,    "url": "https://www.tcgplayer.com/product/659612/"  },  "matches": [    {      "tcgplayer_id": "659612",      "name": "Mega Charizard X ex",      "category": "Pokemon",      "category_id": "3",      "set": "Mega Evolution Promos",      "set_id": "24451",      "card_number": "023",      "rarity": "Promo",      "sub_type": "Holofoil",      "is_card": true,      "image": "https://tcgplayer-cdn.tcgplayer.com/product/659612_in_1000x1000.jpg",      "market_price": 37.63,      "price_change": 0.03,      "price_change_pct": 0.08,      "url": "https://www.tcgplayer.com/product/659612/"    }  ],  "card_url": "string"}
{  "error": {    "code": "invalid_api_key",    "message": "The provided API key is invalid or has been revoked."  }}
{  "error": {    "code": "invalid_api_key",    "message": "The provided API key is invalid or has been revoked."  }}
{  "error": {    "code": "invalid_api_key",    "message": "The provided API key is invalid or has been revoked."  }}
{  "error": {    "code": "invalid_api_key",    "message": "The provided API key is invalid or has been revoked."  }}
{  "error": {    "code": "invalid_api_key",    "message": "The provided API key is invalid or has been revoked."  }}
{  "error": {    "code": "invalid_api_key",    "message": "The provided API key is invalid or has been revoked."  }}
{  "error": {    "code": "invalid_api_key",    "message": "The provided API key is invalid or has been revoked."  }}