keepa.models.backend.Response

pydantic model keepa.models.backend.Response

Backend Response model generated from the Keepa Java schema.

Fields:

• timestamp (int | None)

• tokensLeft (int | None)

• refillIn (int | None)

• refillRate (int | None)

• requestTime (int | None)

• processingTimeInMs (int | None)

• tokenFlowReduction (float | None)

• tokensConsumed (int | None)

• status (keepa.models.backend.ResponseStatus | None)

• statusCode (int | None)

• products (list[keepa.models.backend.Product | None] | None)

• categories (dict[int, keepa.models.backend.Category | None] | None)

• categoryParents (dict[int, keepa.models.backend.Category | None] | None)

• deals (keepa.models.backend.DealResponse | None)

• bestSellersList (keepa.models.backend.BestSellers | None)

• sellers (dict[str, keepa.models.backend.Seller | None] | None)

• trackings (list[keepa.models.backend.Tracking | None] | None)

• notifications (list[keepa.models.backend.Notification | None] | None)

• asinList (list[str | None] | None)

• totalResults (int | None)

• sellerIdList (list[str | None] | None)

• lightningDeals (list[keepa.models.backend.LightningDeal | None] | None)

• error (keepa.models.backend.RequestError | None)

• additional (str | None)

field additional: str | None = None

Contains request specific additional output.

field asinList: list[str | None] | None = None

A list of ASINs. Result of, but not limited to, the get tracking list operation

field bestSellersList: BestSellers | None = None

Results of the best sellers request

field categories: dict[int, Category | None] | None = None

Results of the category lookup and search

field categoryParents: dict[int, Category | None] | None = None

Results of the category lookup and search includeParents parameter

field deals: DealResponse | None = None

Results of the deals request

field error: RequestError | None = None

Contains information about any error that might have occurred.

field lightningDeals: list[LightningDeal | None] | None = None

A list of lightning deals.

field notifications: list[Notification | None] | None = None

Results of get and add tracking operations

field processingTimeInMs: int | None = None

time the request’s processing took (remote), in milliseconds

field products: list[Product | None] | None = None

Results of the product request

field refillIn: int | None = None

Milliseconds till new tokens are generated. Use this if your contingent is depleted to wait before you try a new request. Tokens are generated every 5 minutes.

field refillRate: int | None = None

Token refill rate per minute.

field requestTime: int | None = None

total time the request took (local, including latencies and connection establishment), in milliseconds

field sellerIdList: list[str | None] | None = None

A list of sellerIds.

field sellers: dict[str, Seller | None] | None = None

Results of the deals request

field status: ResponseStatus | None = None

Status of the response.

field statusCode: int | None = None

HTTP Status code of the response.

field timestamp: int | None = None

Server time when response was sent.

field tokenFlowReduction: float | None = None

Token flow reduction

field tokensConsumed: int | None = None

Tokens used for call

field tokensLeft: int | None = None

States how many ASINs may be requested before the assigned API contingent is depleted. If the contingent is depleted, HTTP status code 503 will be delivered with the message: “You are submitting requests too quickly and your requests are being throttled.”

field totalResults: int | None = None

Estimated count of all matched products.

field trackings: list[Tracking | None] | None = None

Results of get and add tracking operations