Skip to content
maxf-docs-dev-7
Get started
API Reference
Pets

Finds Pets by status

pets.find_by_status(PetFindByStatusParams**kwargs) -> PetFindByStatusResponse
GET/pet/findByStatus

Multiple status values can be provided with comma separated strings

ParametersExpand Collapse
status: Optional[Literal["available", "pending", "sold"]]

Status values that need to be considered for filter

Accepts one of the following:
"available"
"pending"
"sold"
ReturnsExpand Collapse
List[Pet]
name: str
photo_urls: List[str]
id: Optional[int]
category: Optional[Category]
id: Optional[int]
name: Optional[str]
status: Optional[Literal["available", "pending", "sold"]]

pet status in the store

Accepts one of the following:
"available"
"pending"
"sold"
tags: Optional[List[Tag]]
id: Optional[int]
name: Optional[str]

Finds Pets by status

import os
from maxf_docs_dev_7 import MaxfDocsDev7

client = MaxfDocsDev7(
    api_key=os.environ.get("PETSTORE_API_KEY"),  # This is the default and can be omitted
)
pets = client.pets.find_by_status()
print(pets)
[
  {
    "name": "doggie",
    "photoUrls": [
      "string"
    ],
    "id": 10,
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "status": "available",
    "tags": [
      {
        "id": 0,
        "name": "name"
      }
    ]
  }
]
Returns Examples
[
  {
    "name": "doggie",
    "photoUrls": [
      "string"
    ],
    "id": 10,
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "status": "available",
    "tags": [
      {
        "id": 0,
        "name": "name"
      }
    ]
  }
]