Search

  • All Images are available via GET https://api.thecatapi.com/images/search
  • You can use Query Parameters to filter by File type, Category & Breed.
    • Full List of available parameters in the /images API Reference in the left menu

Pagination & Ordering

  • The results of /images/search or /images routes can be paginated through, using the limit and page query parameters.

    • limit is the amount of images to return
    • page is the results page to return, 0 is the first.
  • NOTE: Pagination can only be performed when the order query parameter is Desc or Asc - Not the default Rand

  • The total amount of Images available that match the query is returned as the Pagination-Count header

https://api.thecatapi.com/v1/images/search?limit=5&page=10&order=desc - would return 5 Images, from page 10 of entire collection in Descending order

Example - Paginating through Search results
  1. This Example requests https://api.thecatapi.com/v1/images/search?limit=3&page=100&order=DESC
  2. This returns 3 images from page 100 of the entire collection, in Descending order

You can change the order, page or limit to see the result for yourself.

object

The full version of the Image object returned to the account owner via GET /images

id
string
url
string
format: uri
sub_id
string
created_at
string
format: date-time
original_filename
string
categories
array[object]
id
number
name
string
breeds
array[object]
id
string
name
string
temperament
string
life_span
string
alt_names
string
wikipedia_url
string
origin
string
weight_imperial
string
experimental
integer
2 validations
hairless
integer
2 validations
natural
integer
2 validations
rare
integer
2 validations
rex
integer
2 validations
suppress_tail
integer
2 validations
short_legs
integer
2 validations
hypoallergenic
integer
2 validations
adaptability
integer
2 validations
affection_level
integer
2 validations
country_code
string
child_friendly
integer
2 validations
dog_friendly
integer
2 validations
energy_level
integer
2 validations
grooming
integer
2 validations
health_issues
integer
2 validations
intelligence
integer
2 validations
shedding_level
integer
2 validations
social_needs
integer
2 validations
stranger_friendly
integer
2 validations
vocalisation
integer
2 validations