vision

Identify a card from a photo

Send a photograph and get ranked candidate cards. Verified Free accounts get 5 trial recognitions at 25 credits each; ongoing access starts on Growth.

post/v1/vision/identify

Request

  • Base URL: https://api.pokemontcgapi.com
  • URL: https://api.pokemontcgapi.com/v1/vision/identify
  • Auth: API key in header X-Api-Key

Query parameters

includestring

For raw image or multipart bodies: comma-separated index and/or prices.

Request body

imagestring required

The photograph. Three ways to send it: a multipart field named image, the raw bytes as the whole body with an image/* content type, or base64 (a data: URL is accepted) in a JSON field of this name. JPEG, PNG, WebP and GIF; 10 MB and 96 px per side are the bounds.

top_kinteger

How many candidates to return, 1 to 10. In query string when the body is the image itself.

setstring

Restrict to one set code. This is the parameter that resolves a reprint: from artwork alone the original and its reprint are the same card, and if you know which pack it came out of, say so.

regionstring

Restrict to a print region — WEST, JP or CN. Same purpose: a Japanese card and its Western twin share the illustration.

includestring

Comma-separated index and/or prices. In multipart or JSON alongside image; query is also accepted for multipart and raw image bodies. index adds index_eur and last_price_at; prices adds those fields and plan-filtered prices[]. Price restrictions are listed in top-level withheld and X-Plan-Withheld. Unknown values return 400 INVALID_PARAMETER without charge.

Response

Success

withheldstring[]

Top-level plan restrictions with include=prices, as on the card batch.

Changes

No recorded changes to this operation across all 1 revision of this API.