Imgs

    EndpointDescription
    GET /v1/imgs/game_boyGets the Game Boy image
    GET /v1/imgs/pokemon_logoGets the Pokémon logo
    POST /v1/imgs/pokemon_logoUpdates the Pokémon logo
    GET /v1/imgs/town_mapGets the town map

    GET /v1/imgs/game_boy

    Gets the Game Boy image

    Request Parameters

    Location Name Type Required? Description
    header Accept string Type of image to return. Must be "image/png" or "image/jpeg".

    Example Request

    Header:

    GET /v1/imgs/game_boy
    Host: api.pkmnapi.com
    Authorization: Bearer <access_token>
    Accept: image/png
    

    Body:

    None

    Response Parameters

    None

    Example Response

    Header:

    HTTP/1.1 200 OK
    Content-Type: image/png
    Content-Disposition: attachment; filename="game_boy.png"
    Server: pkmnapi/0.1.0
    

    Body:

    game_boy.png

    Gets the Pokémon logo

    Request Parameters

    Location Name Type Required? Description
    header Accept string Type of image to return. Must be "image/png" or "image/jpeg".

    Example Request

    Header:

    GET /v1/imgs/pokemon_logo
    Host: api.pkmnapi.com
    Authorization: Bearer <access_token>
    Accept: image/png
    

    Body:

    None

    Response Parameters

    None

    Example Response

    Header:

    HTTP/1.1 200 OK
    Content-Type: image/png
    Content-Disposition: attachment; filename="pokemon_logo.png"
    Server: pkmnapi/0.1.0
    

    Body:

    pokemon_logo.png


    Updates the Pokémon logo

    Request Parameters

    Location Name Type Required? Description
    header Content-Type string Type of image to upload. Must be "image/png" or "image/jpeg".
    header X-Patch-Description string Description of change.
    body <raw> binary ✔️ Pokémon logo.

    Example Request

    Header:

    POST /v1/imgs/pokemon_logo
    Host: api.pkmnapi.com
    Authorization: Bearer <access_token>
    Content-Type: image/png
    X-Patch-Description: Update Pokémon to Digimon
    

    Body:

    leaf.png

    ⚠️ Images must be 8-bit (or fewer) grayscale and the dimensions must be multiples of 8 pixels

    Response Parameters

    None

    Example Response

    Headers:

    HTTP/1.1 202 Accepted
    Content-Type: application/json
    Server: pkmnapi/0.1.0
    

    Body:

    {}
    

    GET /v1/imgs/town_map

    Gets the town map

    Request Parameters

    Location Name Type Required? Description
    header Accept string Type of image to return. Must be "image/png" or "image/jpeg".

    Example Request

    Header:

    GET /v1/imgs/town_map
    Host: api.pkmnapi.com
    Authorization: Bearer <access_token>
    Accept: image/png
    

    Body:

    None

    Response Parameters

    None

    Example Response

    Header:

    HTTP/1.1 200 OK
    Content-Type: image/png
    Content-Disposition: attachment; filename="town_map.png"
    Server: pkmnapi/0.1.0
    

    Body:

    towm_map.png