getanyapi 0.124.0__tar.gz → 0.126.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {getanyapi-0.124.0 → getanyapi-0.126.0}/PKG-INFO +1 -1
- {getanyapi-0.124.0 → getanyapi-0.126.0}/pyproject.toml +1 -1
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/__init__.py +1 -1
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/asos.py +75 -1
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/brave.py +61 -5
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/duckduckgo.py +7 -3
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/ikea.py +12 -1
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/levels.py +19 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/linktree.py +22 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/samsclub.py +80 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/slickdeals.py +47 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/telegram.py +128 -1
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/tiktok.py +65 -1
- {getanyapi-0.124.0 → getanyapi-0.126.0}/.gitignore +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/README.md +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/_account.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/_async_client.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/_client.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/_errors.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/_idempotency.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/_pagination.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/_transport.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/discovery_types.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/__init__.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/ahrefs.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/airbnb.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/alibaba.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/amazon.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/apollo.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/appstore.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/bestbuy.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/bing.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/bluesky.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/booking.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/capterra.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/chatgpt.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/coinmarketcap.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/company.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/company_enrichment.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/company_identify.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/company_search.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/congress.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/contact_enrichment.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/douyin.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/ebay.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/email.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/email_finding.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/email_verification.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/facebook.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/fiverr.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/g2.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/gemini.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/github.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/glassdoor.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/google.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/google_ads.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/google_finance.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/google_hotels.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/google_shopping.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/hackernews.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/indeed.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/instagram.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/job_search.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/linkedin.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/maps.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/mobile_phone.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/naver.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/nextdoor.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/people_search.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/perplexity.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/person.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/person_enrichment.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/pexels.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/pinterest.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/playstore.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/polymarket.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/property_records.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/realtor.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/reddit.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/redfin.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/rednote.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/sec.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/semrush.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/seo.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/similarweb.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/snapchat.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/social.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/spotify.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/substack.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/target.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/technographics.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/threads.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/tiktok_shop.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/tripadvisor.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/trustpilot.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/truthsocial.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/twitter.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/unsplash.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/upwork.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/walmart.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/web.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/weibo.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/yahoo_finance.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/yelp.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/youtube.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/zhihu.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/platforms/zillow.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/py.typed +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/src/getanyapi/types.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/conftest.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_account.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_client.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_durable_requests.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_envelope.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_errors.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_fixture_roundtrip.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_fixture_sweep.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_not_found_reason.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_pagination.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/tests/test_transport.py +0 -0
- {getanyapi-0.124.0 → getanyapi-0.126.0}/uv.lock +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: getanyapi
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.126.0
|
|
4
4
|
Summary: Official typed Python SDK for AnyAPI: any API, one wallet, USD, no subscriptions.
|
|
5
5
|
Project-URL: Homepage, https://getanyapi.com
|
|
6
6
|
Project-URL: Documentation, https://getanyapi.com/docs
|
|
@@ -24,10 +24,12 @@ class AsosProductInput(TypedDict, total=False):
|
|
|
24
24
|
"""Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way."""
|
|
25
25
|
preferLatencyUnderMs: NotRequired[int]
|
|
26
26
|
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. Minimum: 1."""
|
|
27
|
+
requireFields: NotRequired[list[Literal["sizeGuide"]]]
|
|
28
|
+
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `sizeGuide`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
27
29
|
source: NotRequired[list[str]]
|
|
28
30
|
"""Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`."""
|
|
29
31
|
url: Required[str]
|
|
30
|
-
"""ASOS product page URL, e.g. https://www.asos.com/pullbear/pullbear-casual-trainers-in-white/prd/211299341. The store is read from the URL path (/us/, /au/, /de/ and so on; none means the UK store), and prices come back in that store's currency."""
|
|
32
|
+
"""ASOS product page URL, e.g. https://www.asos.com/pullbear/pullbear-casual-trainers-in-white/prd/211299341, or the short form https://www.asos.com/prd/211299341. The store is read from the URL path (/us/, /au/, /de/ and so on; none means the UK store), and prices come back in that store's currency."""
|
|
31
33
|
|
|
32
34
|
|
|
33
35
|
class AsosSearchInput(TypedDict, total=False):
|
|
@@ -51,6 +53,8 @@ class AsosSearchInput(TypedDict, total=False):
|
|
|
51
53
|
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. Minimum: 1."""
|
|
52
54
|
query: Required[str]
|
|
53
55
|
"""Search keywords, e.g. "white sneakers" or "summer dress"."""
|
|
56
|
+
requireFields: NotRequired[list[Literal["inStock"]]]
|
|
57
|
+
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `inStock`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
54
58
|
sort: NotRequired[Literal["best_match", "new", "price_low", "price_high"]]
|
|
55
59
|
"""Result sort order; omit for ASOS's recommended order (e.g. new for newest arrivals first)."""
|
|
56
60
|
source: NotRequired[list[str]]
|
|
@@ -70,6 +74,11 @@ class AsosProductItem(BaseModel):
|
|
|
70
74
|
default=None,
|
|
71
75
|
description="Brand name, or null when not reported. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
72
76
|
)
|
|
77
|
+
care_instructions: str | None = Field(
|
|
78
|
+
default=None,
|
|
79
|
+
alias="careInstructions",
|
|
80
|
+
description='Care instructions as ASOS lists them, e.g. "Machine wash according to instructions on care label", or null when not listed.',
|
|
81
|
+
)
|
|
73
82
|
colour: str | None = Field(
|
|
74
83
|
default=None,
|
|
75
84
|
description="Colour name as ASOS lists it, or null when not reported.",
|
|
@@ -98,6 +107,15 @@ class AsosProductItem(BaseModel):
|
|
|
98
107
|
alias="inStock",
|
|
99
108
|
description="True when at least one size is in stock, false when none is, or null when not reported.",
|
|
100
109
|
)
|
|
110
|
+
is_discontinued: bool | None = Field(
|
|
111
|
+
default=None,
|
|
112
|
+
alias="isDiscontinued",
|
|
113
|
+
description="True when ASOS has discontinued the product, or null when not reported.",
|
|
114
|
+
)
|
|
115
|
+
materials: str | None = Field(
|
|
116
|
+
default=None,
|
|
117
|
+
description='ASOS\'s "About me" section: fabric and material composition, as HTML, or null when not listed.',
|
|
118
|
+
)
|
|
101
119
|
price: float | None = Field(
|
|
102
120
|
default=None,
|
|
103
121
|
description="Current price in the store's currency, or null when no price is shown. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
@@ -107,6 +125,11 @@ class AsosProductItem(BaseModel):
|
|
|
107
125
|
alias="productId",
|
|
108
126
|
description="ASOS product id. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
109
127
|
)
|
|
128
|
+
size_guide: str | None = Field(
|
|
129
|
+
default=None,
|
|
130
|
+
alias="sizeGuide",
|
|
131
|
+
description="Link to the ASOS size guide for this product, or null when the serving source does not report one.",
|
|
132
|
+
)
|
|
110
133
|
title: str = Field(
|
|
111
134
|
description="Product title. Populated whenever the provider has data for the entity."
|
|
112
135
|
)
|
|
@@ -121,20 +144,48 @@ class AsosProductItem(BaseModel):
|
|
|
121
144
|
class AsosProductVariant(BaseModel):
|
|
122
145
|
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
123
146
|
|
|
147
|
+
colour: str | None = Field(
|
|
148
|
+
default=None,
|
|
149
|
+
description="Colour of this variant as ASOS lists it, or null when not reported.",
|
|
150
|
+
)
|
|
151
|
+
currency: str | None = Field(
|
|
152
|
+
default=None,
|
|
153
|
+
description='Currency code of this size\'s price, e.g. "GBP", or null when not shown.',
|
|
154
|
+
)
|
|
155
|
+
ean: str | None = Field(
|
|
156
|
+
default=None, description="EAN barcode of this size, or null when not reported."
|
|
157
|
+
)
|
|
124
158
|
in_stock: bool | None = Field(
|
|
125
159
|
default=None,
|
|
126
160
|
alias="inStock",
|
|
127
161
|
description="True when this size is in stock, or null when not reported.",
|
|
128
162
|
)
|
|
163
|
+
price: float | None = Field(
|
|
164
|
+
default=None,
|
|
165
|
+
description="Current price of this size in the store's currency, or null when not shown.",
|
|
166
|
+
)
|
|
129
167
|
size: str | None = Field(
|
|
130
168
|
default=None,
|
|
131
169
|
description='Size label as ASOS shows it, e.g. "UK 8", or null when not reported.',
|
|
132
170
|
)
|
|
171
|
+
sku: str | None = Field(
|
|
172
|
+
default=None, description="ASOS SKU of this size, or null when not reported."
|
|
173
|
+
)
|
|
174
|
+
variant_id: str | None = Field(
|
|
175
|
+
default=None,
|
|
176
|
+
alias="variantId",
|
|
177
|
+
description="ASOS variant id of this size, or null when not reported.",
|
|
178
|
+
)
|
|
133
179
|
|
|
134
180
|
|
|
135
181
|
class AsosSearchData(BaseModel):
|
|
136
182
|
model_config = ConfigDict(populate_by_name=True)
|
|
137
183
|
|
|
184
|
+
has_more: bool | None = Field(
|
|
185
|
+
default=None,
|
|
186
|
+
alias="hasMore",
|
|
187
|
+
description="True when another page of results follows this one (request it with page + 1), or null when not reported.",
|
|
188
|
+
)
|
|
138
189
|
items: list[AsosSearchItem] = Field(
|
|
139
190
|
description="Matching ASOS product records for the requested page. Populated whenever the provider has data for the entity."
|
|
140
191
|
)
|
|
@@ -155,6 +206,11 @@ class AsosSearchItem(BaseModel):
|
|
|
155
206
|
default=None,
|
|
156
207
|
description="Colour name as ASOS lists it, or null when not reported.",
|
|
157
208
|
)
|
|
209
|
+
colour_way_id: str | None = Field(
|
|
210
|
+
default=None,
|
|
211
|
+
alias="colourWayId",
|
|
212
|
+
description="Id of the colourway this result shows; it appears as #colourWayId-<id> in ASOS product links. Null when not reported.",
|
|
213
|
+
)
|
|
158
214
|
currency: str | None = Field(
|
|
159
215
|
default=None,
|
|
160
216
|
description='Price currency code, e.g. "GBP" or "USD", or null when no price is shown. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.',
|
|
@@ -163,6 +219,14 @@ class AsosSearchItem(BaseModel):
|
|
|
163
219
|
default=None,
|
|
164
220
|
description="Primary product image URL. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
165
221
|
)
|
|
222
|
+
images: list[str] | None = Field(
|
|
223
|
+
default=None, description="All product image URLs, primary first."
|
|
224
|
+
)
|
|
225
|
+
in_stock: bool | None = Field(
|
|
226
|
+
default=None,
|
|
227
|
+
alias="inStock",
|
|
228
|
+
description="True when the product is in stock, false when it is not, or null when the serving source does not report stock in search results.",
|
|
229
|
+
)
|
|
166
230
|
list_price: float | None = Field(
|
|
167
231
|
default=None,
|
|
168
232
|
alias="listPrice",
|
|
@@ -175,10 +239,20 @@ class AsosSearchItem(BaseModel):
|
|
|
175
239
|
default=None,
|
|
176
240
|
description="Current price in the store's currency, or null when the result shows no price. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
177
241
|
)
|
|
242
|
+
product_code: str | None = Field(
|
|
243
|
+
default=None,
|
|
244
|
+
alias="productCode",
|
|
245
|
+
description="ASOS product code (the style number printed on the product page), or null when not reported.",
|
|
246
|
+
)
|
|
178
247
|
product_id: str = Field(
|
|
179
248
|
alias="productId",
|
|
180
249
|
description="ASOS product id, the number after /prd/ in the product URL; use the product URL with the ASOS Product SKU. Populated whenever the provider has data for the entity.",
|
|
181
250
|
)
|
|
251
|
+
selling_fast: bool | None = Field(
|
|
252
|
+
default=None,
|
|
253
|
+
alias="sellingFast",
|
|
254
|
+
description="True when ASOS flags the product as selling fast, or null when not reported.",
|
|
255
|
+
)
|
|
182
256
|
title: str = Field(
|
|
183
257
|
description="Product title. Populated whenever the provider has data for the entity."
|
|
184
258
|
)
|
|
@@ -67,19 +67,45 @@ class BraveSearchInput(TypedDict, total=False):
|
|
|
67
67
|
"""Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way."""
|
|
68
68
|
limit: NotRequired[int]
|
|
69
69
|
"""Maximum number of organic results to return (1-20, default 20). Brave serves about 20 organic results per page, and some queries carry fewer. Range: 1 to 20. Default: 20."""
|
|
70
|
+
page: NotRequired[int]
|
|
71
|
+
"""Which page of Brave results to return, starting at 1 (up to 10); a page holds about 20 results. Each page is billed as one request. Pages after the first are served only for country US, by the one source that continues each page exactly where the last ended. A limit below the page size drops the rest of that page, so keep the default limit to walk every result. Range: 1 to 10. Default: 1."""
|
|
70
72
|
preferLatencyUnderMs: NotRequired[int]
|
|
71
73
|
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. Minimum: 1."""
|
|
72
74
|
query: Required[str]
|
|
73
75
|
"""The Brave search query."""
|
|
76
|
+
requireFields: NotRequired[
|
|
77
|
+
list[
|
|
78
|
+
Literal[
|
|
79
|
+
"durationSeconds",
|
|
80
|
+
"image",
|
|
81
|
+
"publishedUtc",
|
|
82
|
+
"relatedSearches",
|
|
83
|
+
"source",
|
|
84
|
+
"videos",
|
|
85
|
+
]
|
|
86
|
+
]
|
|
87
|
+
]
|
|
88
|
+
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `relatedSearches` or `publishedUtc`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a record that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
74
89
|
source: NotRequired[list[str]]
|
|
75
90
|
"""Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`."""
|
|
76
91
|
|
|
77
92
|
|
|
78
93
|
class BraveSearchData(BaseModel):
|
|
94
|
+
model_config = ConfigDict(populate_by_name=True)
|
|
95
|
+
|
|
79
96
|
items: list[BraveSearchItem] = Field(
|
|
80
97
|
description="Organic results in Brave's ranked order. Ads are not included. Populated whenever the provider has data for the entity."
|
|
81
98
|
)
|
|
82
99
|
query: str = Field(description="The query Brave searched.")
|
|
100
|
+
related_searches: list[str] | None = Field(
|
|
101
|
+
default=None,
|
|
102
|
+
alias="relatedSearches",
|
|
103
|
+
description="Brave's related searches for the query. An empty array means Brave showed none; null means the source that answered cannot report them.",
|
|
104
|
+
)
|
|
105
|
+
videos: list[BraveSearchVideo] | None = Field(
|
|
106
|
+
default=None,
|
|
107
|
+
description="Video results Brave shows for the query. An empty array means Brave showed none; null means the source that answered cannot report them.",
|
|
108
|
+
)
|
|
83
109
|
|
|
84
110
|
|
|
85
111
|
class BraveSearchItem(BaseModel):
|
|
@@ -93,7 +119,12 @@ class BraveSearchItem(BaseModel):
|
|
|
93
119
|
description="Host of the result URL without a leading www., e.g. runnersworld.com."
|
|
94
120
|
)
|
|
95
121
|
position: int = Field(
|
|
96
|
-
description="1-based rank of the result
|
|
122
|
+
description="1-based rank of the result. On page 2 and later, some sources count from the top of page 1 and others from the top of the page returned. Populated whenever the provider has data for the entity."
|
|
123
|
+
)
|
|
124
|
+
published_utc: int | None = Field(
|
|
125
|
+
default=None,
|
|
126
|
+
alias="publishedUtc",
|
|
127
|
+
description="Page date Brave shows for the result. UTC epoch timestamp in seconds (Unix time). Multiply by 1000 for a JS Date in milliseconds. null when Brave shows no date or the source that answered cannot report it.",
|
|
97
128
|
)
|
|
98
129
|
snippet: str | None = Field(
|
|
99
130
|
default=None,
|
|
@@ -107,6 +138,29 @@ class BraveSearchItem(BaseModel):
|
|
|
107
138
|
)
|
|
108
139
|
|
|
109
140
|
|
|
141
|
+
class BraveSearchVideo(BaseModel):
|
|
142
|
+
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
143
|
+
|
|
144
|
+
duration_seconds: int | None = Field(
|
|
145
|
+
default=None,
|
|
146
|
+
alias="durationSeconds",
|
|
147
|
+
description="Video length in seconds; null when Brave shows none.",
|
|
148
|
+
)
|
|
149
|
+
image: str | None = Field(default=None, description="Thumbnail image URL.")
|
|
150
|
+
published_utc: int | None = Field(
|
|
151
|
+
default=None,
|
|
152
|
+
alias="publishedUtc",
|
|
153
|
+
description="Date Brave shows for the video. UTC epoch timestamp in seconds (Unix time). Multiply by 1000 for a JS Date in milliseconds. null when Brave shows no date.",
|
|
154
|
+
)
|
|
155
|
+
source: str | None = Field(
|
|
156
|
+
default=None, description="Site hosting the video, e.g. YouTube."
|
|
157
|
+
)
|
|
158
|
+
title: str | None = Field(
|
|
159
|
+
default=None, description="Video title as Brave shows it."
|
|
160
|
+
)
|
|
161
|
+
url: str = Field(description="URL of the video page.")
|
|
162
|
+
|
|
163
|
+
|
|
110
164
|
class BraveNamespace:
|
|
111
165
|
"""Typed methods for this platform. Attached lazily to the client."""
|
|
112
166
|
|
|
@@ -123,8 +177,9 @@ class BraveNamespace:
|
|
|
123
177
|
|
|
124
178
|
Run a Brave web search and get the ranked organic results (title, URL,
|
|
125
179
|
snippet, position, display URL, domain) as clean JSON. Brave answers from
|
|
126
|
-
its own independent index. Returns up to 20 results per call
|
|
127
|
-
|
|
180
|
+
its own independent index. Returns up to 20 results per call, with related
|
|
181
|
+
searches and video results where the source has them; page deeper with page
|
|
182
|
+
and pick the country Brave searches from.
|
|
128
183
|
|
|
129
184
|
Price: $0.00085 per request.
|
|
130
185
|
|
|
@@ -153,8 +208,9 @@ class AsyncBraveNamespace:
|
|
|
153
208
|
|
|
154
209
|
Run a Brave web search and get the ranked organic results (title, URL,
|
|
155
210
|
snippet, position, display URL, domain) as clean JSON. Brave answers from
|
|
156
|
-
its own independent index. Returns up to 20 results per call
|
|
157
|
-
|
|
211
|
+
its own independent index. Returns up to 20 results per call, with related
|
|
212
|
+
searches and video results where the source has them; page deeper with page
|
|
213
|
+
and pick the country Brave searches from.
|
|
158
214
|
|
|
159
215
|
Price: $0.00085 per request.
|
|
160
216
|
|
|
@@ -86,6 +86,8 @@ class DuckduckgoSearchInput(TypedDict, total=False):
|
|
|
86
86
|
"""Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way."""
|
|
87
87
|
limit: NotRequired[int]
|
|
88
88
|
"""Maximum number of organic results to return (1-10, default 10). DuckDuckGo serves about 10 organic results per page, and some queries carry fewer. Range: 1 to 10. Default: 10."""
|
|
89
|
+
page: NotRequired[int]
|
|
90
|
+
"""Which page of 10 results to return, starting at 1: page 2 returns results 11-20. Each page is billed as one request. Pages after the first are served only for country US, GB or DE, by the one source that continues each page exactly where the last ended. DuckDuckGo can repeat a result from the previous page, so deduplicate on url, and a limit below 10 drops the rest of that page. Minimum: 1. Default: 1."""
|
|
89
91
|
preferLatencyUnderMs: NotRequired[int]
|
|
90
92
|
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. Minimum: 1."""
|
|
91
93
|
query: Required[str]
|
|
@@ -112,7 +114,7 @@ class DuckduckgoSearchItem(BaseModel):
|
|
|
112
114
|
description="Host of the result URL without a leading www., e.g. runnersworld.com."
|
|
113
115
|
)
|
|
114
116
|
position: int = Field(
|
|
115
|
-
description="1-based rank of the result
|
|
117
|
+
description="1-based rank of the result. On page 2 and later, some sources count from the top of page 1 and others from the top of the page returned. Populated whenever the provider has data for the entity."
|
|
116
118
|
)
|
|
117
119
|
snippet: str | None = Field(
|
|
118
120
|
default=None,
|
|
@@ -142,7 +144,8 @@ class DuckduckgoNamespace:
|
|
|
142
144
|
|
|
143
145
|
Run a DuckDuckGo web search and get the ranked organic results (title, URL,
|
|
144
146
|
snippet, position, display URL, domain) as clean JSON, ads left out. Returns
|
|
145
|
-
up to 10 results per call; pick the country
|
|
147
|
+
up to 10 results per call; page deeper with page and pick the country
|
|
148
|
+
DuckDuckGo searches from.
|
|
146
149
|
|
|
147
150
|
Price: $0.00085 per request.
|
|
148
151
|
|
|
@@ -171,7 +174,8 @@ class AsyncDuckduckgoNamespace:
|
|
|
171
174
|
|
|
172
175
|
Run a DuckDuckGo web search and get the ranked organic results (title, URL,
|
|
173
176
|
snippet, position, display URL, domain) as clean JSON, ads left out. Returns
|
|
174
|
-
up to 10 results per call; pick the country
|
|
177
|
+
up to 10 results per call; page deeper with page and pick the country
|
|
178
|
+
DuckDuckGo searches from.
|
|
175
179
|
|
|
176
180
|
Price: $0.00085 per request.
|
|
177
181
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
from __future__ import annotations
|
|
5
5
|
|
|
6
|
-
from typing import TYPE_CHECKING
|
|
6
|
+
from typing import Literal, TYPE_CHECKING
|
|
7
7
|
|
|
8
8
|
from pydantic import BaseModel, ConfigDict, Field
|
|
9
9
|
from typing_extensions import NotRequired, Required, TypedDict, Unpack
|
|
@@ -28,6 +28,8 @@ class IkeaSearchInput(TypedDict, total=False):
|
|
|
28
28
|
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted. Minimum: 1."""
|
|
29
29
|
query: Required[str]
|
|
30
30
|
"""Search keywords, e.g. "bookshelf" or "desk"."""
|
|
31
|
+
requireFields: NotRequired[list[Literal["memberOffer"]]]
|
|
32
|
+
"""Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `memberOffer`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
31
33
|
source: NotRequired[list[str]]
|
|
32
34
|
"""Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`."""
|
|
33
35
|
|
|
@@ -52,10 +54,19 @@ class IkeaSearchItem(BaseModel):
|
|
|
52
54
|
default=None,
|
|
53
55
|
description='Price currency code, e.g. "USD", or null when no price is shown.',
|
|
54
56
|
)
|
|
57
|
+
dimensions: str | None = Field(
|
|
58
|
+
default=None,
|
|
59
|
+
description='Product dimensions as IKEA lists them, e.g. "31 1/2x11x79 1/2" (inches on the US store), or null when not listed.',
|
|
60
|
+
)
|
|
55
61
|
image: str | None = Field(
|
|
56
62
|
default=None,
|
|
57
63
|
description="Primary product image URL. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
58
64
|
)
|
|
65
|
+
member_offer: str | None = Field(
|
|
66
|
+
default=None,
|
|
67
|
+
alias="memberOffer",
|
|
68
|
+
description='IKEA Family member offer shown on the product, e.g. "In-store only price $65.00", or null when there is none or the serving source does not report it.',
|
|
69
|
+
)
|
|
59
70
|
position: int | None = Field(
|
|
60
71
|
default=None, description="1-based position of the result in this page."
|
|
61
72
|
)
|
|
@@ -40,6 +40,10 @@ class LevelsJobsData(BaseModel):
|
|
|
40
40
|
items: list[LevelsJobsItem] = Field(
|
|
41
41
|
description="Jobs in Levels.fyi's order, grouped by company. Populated whenever the provider has data for the entity."
|
|
42
42
|
)
|
|
43
|
+
total: int | None = Field(
|
|
44
|
+
default=None,
|
|
45
|
+
description="Total number of jobs Levels.fyi matches for the search, beyond the ones returned.",
|
|
46
|
+
)
|
|
43
47
|
|
|
44
48
|
|
|
45
49
|
class LevelsJobsItem(BaseModel):
|
|
@@ -99,6 +103,11 @@ class LevelsJobsItem(BaseModel):
|
|
|
99
103
|
alias="salaryMin",
|
|
100
104
|
description="Low end of the base salary range in salaryCurrency per salaryUnit. null when Levels.fyi shows no salary for the job. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
101
105
|
)
|
|
106
|
+
salary_source: str | None = Field(
|
|
107
|
+
default=None,
|
|
108
|
+
alias="salarySource",
|
|
109
|
+
description="Where the base salary range comes from, as Levels.fyi labels it, e.g. Levels.fyi base salary. null when the job has no salary range.",
|
|
110
|
+
)
|
|
102
111
|
salary_unit: str | None = Field(
|
|
103
112
|
default=None,
|
|
104
113
|
alias="salaryUnit",
|
|
@@ -117,9 +126,19 @@ class LevelsJobsItem(BaseModel):
|
|
|
117
126
|
alias="totalCompensationMin",
|
|
118
127
|
description="Low end of the total compensation range (base, stock and bonus). Some ranges are Levels.fyi estimates. null when Levels.fyi shows none.",
|
|
119
128
|
)
|
|
129
|
+
total_compensation_source: str | None = Field(
|
|
130
|
+
default=None,
|
|
131
|
+
alias="totalCompensationSource",
|
|
132
|
+
description="Where the total compensation range comes from, as Levels.fyi labels it, e.g. Levels.fyi total compensation. Some ranges are Levels.fyi estimates rather than figures the employer posted. null when the job has no total compensation range.",
|
|
133
|
+
)
|
|
120
134
|
url: str = Field(
|
|
121
135
|
description="Levels.fyi job listing URL. Populated whenever the provider has data for the entity."
|
|
122
136
|
)
|
|
137
|
+
workplace_types: list[str] | None = Field(
|
|
138
|
+
default=None,
|
|
139
|
+
alias="workplaceTypes",
|
|
140
|
+
description="Where the job is worked as Levels.fyi lists it, e.g. office or remote. null when Levels.fyi does not say.",
|
|
141
|
+
)
|
|
123
142
|
|
|
124
143
|
|
|
125
144
|
class LevelsNamespace:
|
|
@@ -35,6 +35,16 @@ class LinktreeProfileInput(TypedDict, total=False):
|
|
|
35
35
|
class LinktreeProfileData(BaseModel):
|
|
36
36
|
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
37
37
|
|
|
38
|
+
apple_music: str | None = Field(
|
|
39
|
+
default=None,
|
|
40
|
+
alias="appleMusic",
|
|
41
|
+
description="Apple Music artist URL listed in the page's social icons; null when none.",
|
|
42
|
+
)
|
|
43
|
+
apple_podcast: str | None = Field(
|
|
44
|
+
default=None,
|
|
45
|
+
alias="applePodcast",
|
|
46
|
+
description="Apple Podcasts show URL listed in the page's social icons; null when none.",
|
|
47
|
+
)
|
|
38
48
|
avatar_url: str | None = Field(
|
|
39
49
|
default=None,
|
|
40
50
|
alias="avatarUrl",
|
|
@@ -56,10 +66,18 @@ class LinktreeProfileData(BaseModel):
|
|
|
56
66
|
default=None,
|
|
57
67
|
description="Instagram profile URL listed in the page's social icons; null when none.",
|
|
58
68
|
)
|
|
69
|
+
linkedin: str | None = Field(
|
|
70
|
+
default=None,
|
|
71
|
+
description="LinkedIn profile URL listed in the page's social icons; null when none.",
|
|
72
|
+
)
|
|
59
73
|
links: list[LinktreeProfileLink] | None = Field(
|
|
60
74
|
default=None,
|
|
61
75
|
description="The page's link cards in page order. Headers and group cards have no url. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
62
76
|
)
|
|
77
|
+
soundcloud: str | None = Field(
|
|
78
|
+
default=None,
|
|
79
|
+
description="SoundCloud profile URL listed in the page's social icons; null when none.",
|
|
80
|
+
)
|
|
63
81
|
spotify: str | None = Field(
|
|
64
82
|
default=None,
|
|
65
83
|
description="Spotify artist or show URL listed in the page's social icons; null when none.",
|
|
@@ -76,6 +94,10 @@ class LinktreeProfileData(BaseModel):
|
|
|
76
94
|
default=None,
|
|
77
95
|
description="The page's title; the username when none is set. Null when this source does not report it.",
|
|
78
96
|
)
|
|
97
|
+
twitch: str | None = Field(
|
|
98
|
+
default=None,
|
|
99
|
+
description="Twitch channel URL listed in the page's social icons; null when none.",
|
|
100
|
+
)
|
|
79
101
|
username: str = Field(
|
|
80
102
|
description="The page's Linktree username. Populated whenever the provider has data for the entity."
|
|
81
103
|
)
|
|
@@ -69,6 +69,11 @@ class SamsclubProductItem(BaseModel):
|
|
|
69
69
|
brand: str | None = Field(
|
|
70
70
|
default=None, description="Brand name, or null when not reported."
|
|
71
71
|
)
|
|
72
|
+
club_name: str | None = Field(
|
|
73
|
+
default=None,
|
|
74
|
+
alias="clubName",
|
|
75
|
+
description="Name of the Sam's Club location the price and stock come from, e.g. \"Dallas Sam's Club\", or null when not reported.",
|
|
76
|
+
)
|
|
72
77
|
currency: str | None = Field(
|
|
73
78
|
default=None,
|
|
74
79
|
description='Price currency code, e.g. "USD", or null when no price is shown.',
|
|
@@ -77,6 +82,9 @@ class SamsclubProductItem(BaseModel):
|
|
|
77
82
|
default=None,
|
|
78
83
|
description="Product description text, or null when the listing has none.",
|
|
79
84
|
)
|
|
85
|
+
highlights: list[SamsclubProductHighlight] | None = Field(
|
|
86
|
+
default=None, description="Key facts Sam's Club highlights on the product page."
|
|
87
|
+
)
|
|
80
88
|
image: str | None = Field(
|
|
81
89
|
default=None,
|
|
82
90
|
description="Primary product image URL. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
@@ -94,10 +102,20 @@ class SamsclubProductItem(BaseModel):
|
|
|
94
102
|
alias="listPrice",
|
|
95
103
|
description="Price before Instant Savings, or null when the product is not discounted.",
|
|
96
104
|
)
|
|
105
|
+
member_limit: int | None = Field(
|
|
106
|
+
default=None,
|
|
107
|
+
alias="memberLimit",
|
|
108
|
+
description="Most units one member may buy, or null when no limit is shown.",
|
|
109
|
+
)
|
|
97
110
|
model: str | None = Field(
|
|
98
111
|
default=None,
|
|
99
112
|
description="Manufacturer model number, or null when not reported.",
|
|
100
113
|
)
|
|
114
|
+
order_limit: int | None = Field(
|
|
115
|
+
default=None,
|
|
116
|
+
alias="orderLimit",
|
|
117
|
+
description="Most units one order may contain, or null when no limit is shown.",
|
|
118
|
+
)
|
|
101
119
|
price: float | None = Field(
|
|
102
120
|
default=None,
|
|
103
121
|
description="Current member price in USD, or null when no price is shown. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
@@ -106,6 +124,11 @@ class SamsclubProductItem(BaseModel):
|
|
|
106
124
|
default=None,
|
|
107
125
|
description="Average customer rating, 0-5, or null when the product is unrated.",
|
|
108
126
|
)
|
|
127
|
+
rating_distribution: SamsclubProductRatingDistribution | None = Field(
|
|
128
|
+
default=None,
|
|
129
|
+
alias="ratingDistribution",
|
|
130
|
+
description='Number of reviews at each star rating, keyed "1" through "5".',
|
|
131
|
+
)
|
|
109
132
|
reviews_count: int | None = Field(
|
|
110
133
|
default=None,
|
|
111
134
|
alias="reviewsCount",
|
|
@@ -114,6 +137,11 @@ class SamsclubProductItem(BaseModel):
|
|
|
114
137
|
title: str = Field(
|
|
115
138
|
description="Product title. Populated whenever the provider has data for the entity."
|
|
116
139
|
)
|
|
140
|
+
unit_price: str | None = Field(
|
|
141
|
+
default=None,
|
|
142
|
+
alias="unitPrice",
|
|
143
|
+
description='Unit price as Sam\'s Club shows it, e.g. "$0.04/sft", or null when not shown.',
|
|
144
|
+
)
|
|
117
145
|
upc: str | None = Field(
|
|
118
146
|
default=None, description="Universal Product Code, or null when not reported."
|
|
119
147
|
)
|
|
@@ -122,9 +150,43 @@ class SamsclubProductItem(BaseModel):
|
|
|
122
150
|
)
|
|
123
151
|
|
|
124
152
|
|
|
153
|
+
class SamsclubProductHighlight(BaseModel):
|
|
154
|
+
model_config = ConfigDict(extra="allow")
|
|
155
|
+
|
|
156
|
+
label: str | None = Field(default=None, description='Highlight name, e.g. "Brand".')
|
|
157
|
+
value: str | None = Field(
|
|
158
|
+
default=None, description='Highlight value, e.g. "Bounty".'
|
|
159
|
+
)
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
class SamsclubProductRatingDistribution(BaseModel):
|
|
163
|
+
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
164
|
+
|
|
165
|
+
field_1: int | None = Field(
|
|
166
|
+
default=None, alias="1", description="Number of 1-star reviews."
|
|
167
|
+
)
|
|
168
|
+
field_2: int | None = Field(
|
|
169
|
+
default=None, alias="2", description="Number of 2-star reviews."
|
|
170
|
+
)
|
|
171
|
+
field_3: int | None = Field(
|
|
172
|
+
default=None, alias="3", description="Number of 3-star reviews."
|
|
173
|
+
)
|
|
174
|
+
field_4: int | None = Field(
|
|
175
|
+
default=None, alias="4", description="Number of 4-star reviews."
|
|
176
|
+
)
|
|
177
|
+
field_5: int | None = Field(
|
|
178
|
+
default=None, alias="5", description="Number of 5-star reviews."
|
|
179
|
+
)
|
|
180
|
+
|
|
181
|
+
|
|
125
182
|
class SamsclubSearchData(BaseModel):
|
|
126
183
|
model_config = ConfigDict(populate_by_name=True)
|
|
127
184
|
|
|
185
|
+
has_more: bool | None = Field(
|
|
186
|
+
default=None,
|
|
187
|
+
alias="hasMore",
|
|
188
|
+
description="True when another page of results follows this one (request it with page + 1), or null when not reported.",
|
|
189
|
+
)
|
|
128
190
|
items: list[SamsclubSearchItem] = Field(
|
|
129
191
|
description="Matching Sam's Club product records for the requested page, sponsored tiles left out. Prices are those of Sam's Club's default club. Populated whenever the provider has data for the entity."
|
|
130
192
|
)
|
|
@@ -133,6 +195,11 @@ class SamsclubSearchData(BaseModel):
|
|
|
133
195
|
alias="totalResults",
|
|
134
196
|
description="Number of organic products Sam's Club returns for the query (sponsored tiles are left out), or null when not reported.",
|
|
135
197
|
)
|
|
198
|
+
total_results_exact: bool | None = Field(
|
|
199
|
+
default=None,
|
|
200
|
+
alias="totalResultsExact",
|
|
201
|
+
description="True when totalResults is an exact count, false when it is an estimate, or null when not reported.",
|
|
202
|
+
)
|
|
136
203
|
|
|
137
204
|
|
|
138
205
|
class SamsclubSearchItem(BaseModel):
|
|
@@ -146,6 +213,10 @@ class SamsclubSearchItem(BaseModel):
|
|
|
146
213
|
default=None,
|
|
147
214
|
description='Price currency code, e.g. "USD", or null when no price is shown.',
|
|
148
215
|
)
|
|
216
|
+
fulfillment: list[str] | None = Field(
|
|
217
|
+
default=None,
|
|
218
|
+
description='Ways the item can be fulfilled at the pickup club, e.g. "PICKUP", "DELIVERY", "SHIPPING"; empty when none is offered.',
|
|
219
|
+
)
|
|
149
220
|
image: str | None = Field(
|
|
150
221
|
default=None,
|
|
151
222
|
description="Primary product image URL. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
@@ -159,6 +230,11 @@ class SamsclubSearchItem(BaseModel):
|
|
|
159
230
|
alias="listPrice",
|
|
160
231
|
description="Price before Instant Savings, or null when the product is not discounted.",
|
|
161
232
|
)
|
|
233
|
+
pickup_club_id: str | None = Field(
|
|
234
|
+
default=None,
|
|
235
|
+
alias="pickupClubId",
|
|
236
|
+
description="Id of the Sam's Club location whose stock and fulfillment the result reflects, or null when not reported.",
|
|
237
|
+
)
|
|
162
238
|
position: int | None = Field(
|
|
163
239
|
default=None, description="1-based organic position of the result in this page."
|
|
164
240
|
)
|
|
@@ -166,6 +242,10 @@ class SamsclubSearchItem(BaseModel):
|
|
|
166
242
|
default=None,
|
|
167
243
|
description="Current member price in USD, or null when the result shows no price. Populated whenever the provider has data for the entity. Present whenever the upstream returns this record.",
|
|
168
244
|
)
|
|
245
|
+
promotions: list[str] | None = Field(
|
|
246
|
+
default=None,
|
|
247
|
+
description='Promotion labels shown on the result, e.g. "$40 off" or "Sam\'s Cash Offer"; empty when none.',
|
|
248
|
+
)
|
|
169
249
|
rating: float | None = Field(
|
|
170
250
|
default=None,
|
|
171
251
|
description="Average customer rating, 0-5, or null when the product is unrated.",
|