getanyapi 0.103.0__tar.gz → 0.104.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.103.0 → getanyapi-0.104.0}/PKG-INFO +1 -1
- {getanyapi-0.103.0 → getanyapi-0.104.0}/pyproject.toml +1 -1
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/__init__.py +1 -1
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/booking.py +2 -2
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/chatgpt.py +3 -2
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/google_hotels.py +4 -4
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/instagram.py +18 -27
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/linkedin.py +4 -3
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/threads.py +6 -4
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/tiktok.py +3 -3
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/twitter.py +77 -79
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/youtube.py +7 -6
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/zillow.py +4 -3
- {getanyapi-0.103.0 → getanyapi-0.104.0}/.gitignore +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/README.md +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/_account.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/_async_client.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/_client.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/_errors.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/_idempotency.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/_pagination.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/_transport.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/discovery_types.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/__init__.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/ahrefs.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/airbnb.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/alibaba.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/amazon.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/apollo.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/appstore.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/bluesky.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/capterra.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/coinmarketcap.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/company.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/company_enrichment.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/company_identify.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/company_search.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/congress.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/contact_enrichment.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/douyin.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/ebay.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/email.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/email_finding.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/email_verification.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/facebook.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/fiverr.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/g2.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/gemini.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/github.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/glassdoor.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/google.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/google_ads.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/google_finance.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/google_shopping.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/hackernews.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/indeed.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/job_search.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/maps.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/mobile_phone.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/naver.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/nextdoor.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/people_search.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/perplexity.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/person.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/person_enrichment.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/pexels.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/pinterest.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/playstore.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/polymarket.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/property_records.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/realtor.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/reddit.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/redfin.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/rednote.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/sec.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/semrush.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/seo.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/similarweb.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/snapchat.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/social.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/spotify.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/substack.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/technographics.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/tiktok_shop.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/tripadvisor.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/trustpilot.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/truthsocial.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/unsplash.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/upwork.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/walmart.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/web.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/weibo.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/yahoo_finance.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/yelp.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/platforms/zhihu.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/py.typed +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/src/getanyapi/types.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/conftest.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_account.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_client.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_durable_requests.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_envelope.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_errors.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_fixture_roundtrip.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_fixture_sweep.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_not_found_reason.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_pagination.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.0}/tests/test_transport.py +0 -0
- {getanyapi-0.103.0 → getanyapi-0.104.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.104.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
|
|
@@ -153,7 +153,7 @@ class BookingNamespace:
|
|
|
153
153
|
Price: $0.0022 per request plus $0.00495 per result (maximum $0.102).
|
|
154
154
|
|
|
155
155
|
Example:
|
|
156
|
-
res = client.booking.search(adults=2, checkIn="2026-11-
|
|
156
|
+
res = client.booking.search(adults=2, checkIn="2026-11-15", checkOut="2026-11-17", limit=3, query="New York")
|
|
157
157
|
"""
|
|
158
158
|
raw = self._client._run_raw( # pyright: ignore[reportPrivateUsage]
|
|
159
159
|
"booking.search", dict(input), options
|
|
@@ -182,7 +182,7 @@ class AsyncBookingNamespace:
|
|
|
182
182
|
Price: $0.0022 per request plus $0.00495 per result (maximum $0.102).
|
|
183
183
|
|
|
184
184
|
Example:
|
|
185
|
-
res = client.booking.search(adults=2, checkIn="2026-11-
|
|
185
|
+
res = client.booking.search(adults=2, checkIn="2026-11-15", checkOut="2026-11-17", limit=3, query="New York")
|
|
186
186
|
"""
|
|
187
187
|
raw = await self._client._arun_raw( # pyright: ignore[reportPrivateUsage]
|
|
188
188
|
"booking.search", dict(input), options
|
|
@@ -195,7 +195,7 @@ class ChatgptSearchPlace(BaseModel):
|
|
|
195
195
|
website_url: str | None = Field(
|
|
196
196
|
default=None,
|
|
197
197
|
alias="websiteUrl",
|
|
198
|
-
description="Place website URL
|
|
198
|
+
description="Place website URL with tracking parameters stripped; an id parameter is kept, since a page such as Facebook profile.php needs it.",
|
|
199
199
|
)
|
|
200
200
|
|
|
201
201
|
|
|
@@ -238,7 +238,8 @@ class ChatgptSearchShoppingCard(BaseModel):
|
|
|
238
238
|
)
|
|
239
239
|
title: str = Field(description="Product name shown by ChatGPT.")
|
|
240
240
|
url: str | None = Field(
|
|
241
|
-
default=None,
|
|
241
|
+
default=None,
|
|
242
|
+
description="Product page URL with its query kept, since the query can name the product variant (e.g. color and size).",
|
|
242
243
|
)
|
|
243
244
|
|
|
244
245
|
|
|
@@ -695,7 +695,7 @@ class GoogleHotelsNamespace:
|
|
|
695
695
|
Price: $0.0015 per request.
|
|
696
696
|
|
|
697
697
|
Example:
|
|
698
|
-
res = client.google_hotels.details(checkIn="2026-11-
|
|
698
|
+
res = client.google_hotels.details(checkIn="2026-11-15", checkOut="2026-11-17", country="us", propertyToken="ChcImaG28Zbom8uuARoKL20vMDNncTd2NBAB")
|
|
699
699
|
"""
|
|
700
700
|
raw = self._client._run_raw( # pyright: ignore[reportPrivateUsage]
|
|
701
701
|
"google_hotels.details", dict(input), options
|
|
@@ -717,7 +717,7 @@ class GoogleHotelsNamespace:
|
|
|
717
717
|
Price: $0.0015 per request.
|
|
718
718
|
|
|
719
719
|
Example:
|
|
720
|
-
res = client.google_hotels.search(checkIn="2026-11-
|
|
720
|
+
res = client.google_hotels.search(checkIn="2026-11-15", checkOut="2026-11-17", country="us", query="hotels near times square new york")
|
|
721
721
|
"""
|
|
722
722
|
raw = self._client._run_raw( # pyright: ignore[reportPrivateUsage]
|
|
723
723
|
"google_hotels.search", dict(input), options
|
|
@@ -746,7 +746,7 @@ class AsyncGoogleHotelsNamespace:
|
|
|
746
746
|
Price: $0.0015 per request.
|
|
747
747
|
|
|
748
748
|
Example:
|
|
749
|
-
res = client.google_hotels.details(checkIn="2026-11-
|
|
749
|
+
res = client.google_hotels.details(checkIn="2026-11-15", checkOut="2026-11-17", country="us", propertyToken="ChcImaG28Zbom8uuARoKL20vMDNncTd2NBAB")
|
|
750
750
|
"""
|
|
751
751
|
raw = await self._client._arun_raw( # pyright: ignore[reportPrivateUsage]
|
|
752
752
|
"google_hotels.details", dict(input), options
|
|
@@ -768,7 +768,7 @@ class AsyncGoogleHotelsNamespace:
|
|
|
768
768
|
Price: $0.0015 per request.
|
|
769
769
|
|
|
770
770
|
Example:
|
|
771
|
-
res = client.google_hotels.search(checkIn="2026-11-
|
|
771
|
+
res = client.google_hotels.search(checkIn="2026-11-15", checkOut="2026-11-17", country="us", query="hotels near times square new york")
|
|
772
772
|
"""
|
|
773
773
|
raw = await self._client._arun_raw( # pyright: ignore[reportPrivateUsage]
|
|
774
774
|
"google_hotels.search", dict(input), options
|
|
@@ -236,24 +236,7 @@ class InstagramPostInput(TypedDict, total=False):
|
|
|
236
236
|
"""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."""
|
|
237
237
|
preferLatencyUnderMs: NotRequired[int]
|
|
238
238
|
"""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."""
|
|
239
|
-
requireFields: NotRequired[
|
|
240
|
-
list[
|
|
241
|
-
Literal[
|
|
242
|
-
"avatarUrl",
|
|
243
|
-
"comments",
|
|
244
|
-
"createdUtc",
|
|
245
|
-
"displayName",
|
|
246
|
-
"hasAudio",
|
|
247
|
-
"locationId",
|
|
248
|
-
"locationName",
|
|
249
|
-
"paidPartnership",
|
|
250
|
-
"plays",
|
|
251
|
-
"productType",
|
|
252
|
-
"userId",
|
|
253
|
-
"verified",
|
|
254
|
-
]
|
|
255
|
-
]
|
|
256
|
-
]
|
|
239
|
+
requireFields: NotRequired[list[Literal["hasAudio", "locationId", "plays"]]]
|
|
257
240
|
"""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 `plays`, 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 post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
258
241
|
requirePlayCount: NotRequired[bool]
|
|
259
242
|
"""Deprecated; send `requireFields: ["plays"]` instead, which does exactly the same thing. Set true to be served only by a source that reports a reel's play count. Omit it and routing is unchanged, with the cheapest source serving, which does not carry play counts, so `plays` is absent from its responses. This can raise your price: opting in routes to a source that reports the count, and you are quoted and charged its price. It stays accepted so callers that already send it keep working."""
|
|
@@ -376,6 +359,8 @@ class InstagramSearchInput(TypedDict, total=False):
|
|
|
376
359
|
"""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."""
|
|
377
360
|
query: Required[str]
|
|
378
361
|
"""Keyword to search Instagram for; one or more words without special punctuation (e.g. coffee roastery)."""
|
|
362
|
+
requireFields: NotRequired[list[Literal["postsCount"]]]
|
|
363
|
+
"""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 `postsCount`, 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 profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
379
364
|
source: NotRequired[list[str]]
|
|
380
365
|
"""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`."""
|
|
381
366
|
type: NotRequired[Literal["user", "hashtag", "place"]]
|
|
@@ -597,6 +582,8 @@ class InstagramUserPostsInput(TypedDict, total=False):
|
|
|
597
582
|
"""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."""
|
|
598
583
|
preferLatencyUnderMs: NotRequired[int]
|
|
599
584
|
"""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."""
|
|
585
|
+
requireFields: NotRequired[list[Literal["userId"]]]
|
|
586
|
+
"""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 `userId`, 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 post that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
600
587
|
source: NotRequired[list[str]]
|
|
601
588
|
"""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`."""
|
|
602
589
|
|
|
@@ -797,7 +784,7 @@ class InstagramFollowersData(BaseModel):
|
|
|
797
784
|
next_cursor: str | None = Field(
|
|
798
785
|
default=None,
|
|
799
786
|
alias="nextCursor",
|
|
800
|
-
description="Opaque cursor for the next page of followers, or null/empty when there are no more.
|
|
787
|
+
description="Opaque cursor for the next page of followers, or null/empty when there are no more. Some sources return a single page of about 50 followers and no continuation, so it is empty there. Pass it back as cursor whenever it is non-empty.",
|
|
801
788
|
)
|
|
802
789
|
|
|
803
790
|
|
|
@@ -812,7 +799,7 @@ class InstagramFollowersItem(BaseModel):
|
|
|
812
799
|
)
|
|
813
800
|
image: str | None = Field(
|
|
814
801
|
default=None,
|
|
815
|
-
description="URL of the follower's profile picture,
|
|
802
|
+
description="URL of the follower's profile picture, kept whole because its query carries the CDN signature. Empty when the upstream omits it.",
|
|
816
803
|
)
|
|
817
804
|
name: str | None = Field(
|
|
818
805
|
default=None,
|
|
@@ -839,7 +826,7 @@ class InstagramFollowingData(BaseModel):
|
|
|
839
826
|
next_cursor: str | None = Field(
|
|
840
827
|
default=None,
|
|
841
828
|
alias="nextCursor",
|
|
842
|
-
description="Opaque cursor for the next page of results, or null/empty when there are no more.
|
|
829
|
+
description="Opaque cursor for the next page of results, or null/empty when there are no more. Some sources return a single page of about 50 accounts and no continuation, so it is empty there. Pass it back as cursor whenever it is non-empty.",
|
|
843
830
|
)
|
|
844
831
|
|
|
845
832
|
|
|
@@ -854,7 +841,7 @@ class InstagramFollowingItem(BaseModel):
|
|
|
854
841
|
)
|
|
855
842
|
image: str | None = Field(
|
|
856
843
|
default=None,
|
|
857
|
-
description="URL of the followed account's profile picture,
|
|
844
|
+
description="URL of the followed account's profile picture, kept whole because its query carries the CDN signature. Empty when the upstream omits it.",
|
|
858
845
|
)
|
|
859
846
|
name: str | None = Field(
|
|
860
847
|
default=None,
|
|
@@ -1837,7 +1824,7 @@ class InstagramSearchItem(BaseModel):
|
|
|
1837
1824
|
)
|
|
1838
1825
|
image: str | None = Field(
|
|
1839
1826
|
default=None,
|
|
1840
|
-
description="URL of the account's profile picture,
|
|
1827
|
+
description="URL of the account's profile picture, kept whole because its query carries the CDN signature. Empty when the upstream omits it.",
|
|
1841
1828
|
)
|
|
1842
1829
|
name: str | None = Field(
|
|
1843
1830
|
default=None,
|
|
@@ -1846,7 +1833,7 @@ class InstagramSearchItem(BaseModel):
|
|
|
1846
1833
|
posts_count: int | None = Field(
|
|
1847
1834
|
default=None,
|
|
1848
1835
|
alias="postsCount",
|
|
1849
|
-
description="The account's post count.
|
|
1836
|
+
description="The account's post count. Null when the serving source does not report it.",
|
|
1850
1837
|
)
|
|
1851
1838
|
url: str = Field(
|
|
1852
1839
|
description="Canonical URL of the account's profile, with tracking query params stripped. Populated whenever the provider has data for the entity."
|
|
@@ -2087,7 +2074,9 @@ class InstagramSearchProfilesProfile(BaseModel):
|
|
|
2087
2074
|
id: str = Field(
|
|
2088
2075
|
description="Populated whenever the provider has data for the entity."
|
|
2089
2076
|
)
|
|
2090
|
-
posts: int
|
|
2077
|
+
posts: int | None = Field(
|
|
2078
|
+
description="Total number of posts on the account. Null when the serving source does not report it."
|
|
2079
|
+
)
|
|
2091
2080
|
private: bool | None = Field(
|
|
2092
2081
|
description="Whether the account is private. Null when the serving source does not report it."
|
|
2093
2082
|
)
|
|
@@ -2152,7 +2141,9 @@ class InstagramSearchProfilesContactProfile(BaseModel):
|
|
|
2152
2141
|
default=None,
|
|
2153
2142
|
description="Public contact phone number the account lists, in international format. Absent when the account does not publish one.",
|
|
2154
2143
|
)
|
|
2155
|
-
posts: int = Field(
|
|
2144
|
+
posts: int | None = Field(
|
|
2145
|
+
description="Number of posts on the profile. Null when the serving source does not report it."
|
|
2146
|
+
)
|
|
2156
2147
|
url: str | None = Field(default=None, description="Canonical URL of the profile.")
|
|
2157
2148
|
verified: bool = Field(description="Whether the account has a verified badge.")
|
|
2158
2149
|
|
|
@@ -2515,7 +2506,7 @@ class InstagramUserPostsPost(BaseModel):
|
|
|
2515
2506
|
user_id: str | None = Field(
|
|
2516
2507
|
default=None,
|
|
2517
2508
|
alias="userId",
|
|
2518
|
-
description="Instagram user id of the posting account.",
|
|
2509
|
+
description="Instagram user id of the posting account. Null when the serving source does not report it.",
|
|
2519
2510
|
)
|
|
2520
2511
|
username: str = Field(
|
|
2521
2512
|
description="Username of the account that posted. A profile feed includes collaborator posts, so this is not always the requested handle. Populated whenever the provider has data for the entity."
|
|
@@ -1691,7 +1691,7 @@ class LinkedinCompanyPostsAuthor(BaseModel):
|
|
|
1691
1691
|
|
|
1692
1692
|
followers: str | None = Field(
|
|
1693
1693
|
default=None,
|
|
1694
|
-
description="Author follower count as displayed text (e.g. '1,543,793 followers').",
|
|
1694
|
+
description="Author follower count as displayed text (e.g. '1,543,793 followers'). Absent when the author is a person, whose card shows a headline instead.",
|
|
1695
1695
|
)
|
|
1696
1696
|
handle: str | None = Field(
|
|
1697
1697
|
default=None, description="Public identifier (vanity handle) of the author."
|
|
@@ -4012,7 +4012,7 @@ class LinkedinSearchPostsFullPost(BaseModel):
|
|
|
4012
4012
|
attachment_url: str | None = Field(
|
|
4013
4013
|
default=None,
|
|
4014
4014
|
alias="attachmentUrl",
|
|
4015
|
-
description="
|
|
4015
|
+
description="Destination URL of the attachment with tracking parameters removed; a video keeps the signed query it needs to play, and a YouTube link keeps its video id. When attachmentType is article, pass this URL to the linkedin.article endpoint to read the article's full body text.",
|
|
4016
4016
|
)
|
|
4017
4017
|
author: LinkedinSearchPostsFullAuthor = Field(
|
|
4018
4018
|
description="Public author identity attached to the post. Populated whenever the provider has data for the entity."
|
|
@@ -4211,7 +4211,8 @@ class LinkedinSearchProfilesItem(BaseModel):
|
|
|
4211
4211
|
description="Whether the member has a LinkedIn Premium subscription.",
|
|
4212
4212
|
)
|
|
4213
4213
|
skills: list[Any] | None = Field(
|
|
4214
|
-
default=None,
|
|
4214
|
+
default=None,
|
|
4215
|
+
description="Listed skills, one object per skill with its name and, when the source has them, the endorsements label and related positions.",
|
|
4215
4216
|
)
|
|
4216
4217
|
state: str | None = Field(
|
|
4217
4218
|
default=None, description="State or region of the member."
|
|
@@ -126,11 +126,13 @@ class ThreadsPostData(BaseModel):
|
|
|
126
126
|
alias="quoteCount",
|
|
127
127
|
description="Number of quote posts. Null when the source does not report it.",
|
|
128
128
|
)
|
|
129
|
-
reply_count: int = Field(
|
|
130
|
-
alias="replyCount",
|
|
129
|
+
reply_count: int | None = Field(
|
|
130
|
+
alias="replyCount",
|
|
131
|
+
description="Number of replies to the post. Null when the source does not report it.",
|
|
131
132
|
)
|
|
132
|
-
repost_count: int = Field(
|
|
133
|
-
alias="repostCount",
|
|
133
|
+
repost_count: int | None = Field(
|
|
134
|
+
alias="repostCount",
|
|
135
|
+
description="Number of reposts of the post. Null when the source does not report it.",
|
|
134
136
|
)
|
|
135
137
|
text: str = Field(
|
|
136
138
|
description="Post text content. Populated whenever the provider has data for the entity."
|
|
@@ -469,8 +469,8 @@ class TiktokSearchUsersInput(TypedDict, total=False):
|
|
|
469
469
|
"""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."""
|
|
470
470
|
query: Required[str]
|
|
471
471
|
"""The keyword to search TikTok accounts for."""
|
|
472
|
-
requireFields: NotRequired[list[Literal["nextCursor"
|
|
473
|
-
"""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 `nextCursor
|
|
472
|
+
requireFields: NotRequired[list[Literal["nextCursor"]]]
|
|
473
|
+
"""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 `nextCursor`, 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."""
|
|
474
474
|
source: NotRequired[list[str]]
|
|
475
475
|
"""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`."""
|
|
476
476
|
|
|
@@ -1118,7 +1118,7 @@ class TiktokHashtagVideosItem(BaseModel):
|
|
|
1118
1118
|
)
|
|
1119
1119
|
image: str | None = Field(
|
|
1120
1120
|
default=None,
|
|
1121
|
-
description="URL of the video's cover/thumbnail image,
|
|
1121
|
+
description="URL of the video's cover/thumbnail image. Signed and short-lived, so the query string is load-bearing and kept intact. Empty when the upstream omits it.",
|
|
1122
1122
|
)
|
|
1123
1123
|
like_count: int | None = Field(
|
|
1124
1124
|
default=None,
|
|
@@ -248,10 +248,8 @@ class TwitterTweetInput(TypedDict, total=False):
|
|
|
248
248
|
"""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."""
|
|
249
249
|
preferLatencyUnderMs: NotRequired[int]
|
|
250
250
|
"""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."""
|
|
251
|
-
requireFields: NotRequired[
|
|
252
|
-
|
|
253
|
-
]
|
|
254
|
-
"""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 `media` or `videoUrl`, 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 tweet that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
251
|
+
requireFields: NotRequired[list[Literal["height", "videoUrl", "width"]]]
|
|
252
|
+
"""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 `videoUrl` or `width`, 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 tweet that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge."""
|
|
255
253
|
source: NotRequired[list[str]]
|
|
256
254
|
"""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`."""
|
|
257
255
|
url: Required[str]
|
|
@@ -286,8 +284,8 @@ class TwitterUserPostsInput(TypedDict, total=False):
|
|
|
286
284
|
"""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."""
|
|
287
285
|
preferLatencyUnderMs: NotRequired[int]
|
|
288
286
|
"""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."""
|
|
289
|
-
requireFields: NotRequired[list[Literal["isPinned"
|
|
290
|
-
"""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 `isPinned
|
|
287
|
+
requireFields: NotRequired[list[Literal["isPinned"]]]
|
|
288
|
+
"""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 `isPinned`, 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 tweet that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. 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."""
|
|
291
289
|
source: NotRequired[list[str]]
|
|
292
290
|
"""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`."""
|
|
293
291
|
|
|
@@ -341,14 +339,6 @@ class TwitterArticleData(BaseModel):
|
|
|
341
339
|
default=None,
|
|
342
340
|
description="Wrapper post like count at retrieval time. Minimum: 0.",
|
|
343
341
|
)
|
|
344
|
-
media_count: int | None = Field(
|
|
345
|
-
default=None,
|
|
346
|
-
alias="mediaCount",
|
|
347
|
-
description="Number of media items the author has published.",
|
|
348
|
-
)
|
|
349
|
-
posts: int | None = Field(
|
|
350
|
-
default=None, description="Number of posts the author has published."
|
|
351
|
-
)
|
|
352
342
|
preview_text: str | None = Field(
|
|
353
343
|
default=None, alias="previewText", description="Preview text supplied by X."
|
|
354
344
|
)
|
|
@@ -406,7 +396,15 @@ class TwitterArticleAuthor(BaseModel):
|
|
|
406
396
|
location: str | None = Field(
|
|
407
397
|
default=None, description="Self-reported profile location."
|
|
408
398
|
)
|
|
399
|
+
media_count: int | None = Field(
|
|
400
|
+
default=None,
|
|
401
|
+
alias="mediaCount",
|
|
402
|
+
description="Number of media items the author has published.",
|
|
403
|
+
)
|
|
409
404
|
name: str | None = Field(default=None, description="Profile display name.")
|
|
405
|
+
posts: int | None = Field(
|
|
406
|
+
default=None, description="Number of posts the author has published."
|
|
407
|
+
)
|
|
410
408
|
url: str = Field(
|
|
411
409
|
description="Canonical public X profile URL. Populated whenever the provider has data for the entity."
|
|
412
410
|
)
|
|
@@ -547,14 +545,6 @@ class TwitterCommunityTweetsTweet(BaseModel):
|
|
|
547
545
|
class TwitterFollowersData(BaseModel):
|
|
548
546
|
model_config = ConfigDict(populate_by_name=True)
|
|
549
547
|
|
|
550
|
-
created_utc: float | None = Field(
|
|
551
|
-
default=None,
|
|
552
|
-
alias="createdUtc",
|
|
553
|
-
description="UTC epoch timestamp in seconds (Unix time) the account was created. Multiply by 1000 for a JS Date in milliseconds.",
|
|
554
|
-
)
|
|
555
|
-
id: str | None = Field(
|
|
556
|
-
default=None, description="Numeric X user id of the account, as a string."
|
|
557
|
-
)
|
|
558
548
|
items: list[TwitterFollowersItem] = Field(
|
|
559
549
|
description="Follower records, normalized to a compact shape. Populated whenever the provider has data for the entity."
|
|
560
550
|
)
|
|
@@ -575,10 +565,18 @@ class TwitterFollowersItem(BaseModel):
|
|
|
575
565
|
bio: str | None = Field(
|
|
576
566
|
default=None, description="The account's profile bio/description."
|
|
577
567
|
)
|
|
568
|
+
created_utc: float | None = Field(
|
|
569
|
+
default=None,
|
|
570
|
+
alias="createdUtc",
|
|
571
|
+
description="UTC epoch timestamp in seconds (Unix time) the account was created. Multiply by 1000 for a JS Date in milliseconds.",
|
|
572
|
+
)
|
|
578
573
|
followers: int = Field(description="How many followers this account has.")
|
|
579
574
|
following: int | None = Field(
|
|
580
575
|
default=None, description="How many accounts this account follows."
|
|
581
576
|
)
|
|
577
|
+
id: str | None = Field(
|
|
578
|
+
default=None, description="Numeric X user id of the account, as a string."
|
|
579
|
+
)
|
|
582
580
|
location: str = Field(
|
|
583
581
|
description="The account's self-reported location (may be empty)."
|
|
584
582
|
)
|
|
@@ -594,14 +592,6 @@ class TwitterFollowersItem(BaseModel):
|
|
|
594
592
|
class TwitterFollowingData(BaseModel):
|
|
595
593
|
model_config = ConfigDict(populate_by_name=True)
|
|
596
594
|
|
|
597
|
-
created_utc: float | None = Field(
|
|
598
|
-
default=None,
|
|
599
|
-
alias="createdUtc",
|
|
600
|
-
description="UTC epoch timestamp in seconds (Unix time) the account was created. Multiply by 1000 for a JS Date in milliseconds.",
|
|
601
|
-
)
|
|
602
|
-
id: str | None = Field(
|
|
603
|
-
default=None, description="Numeric X user id of the account, as a string."
|
|
604
|
-
)
|
|
605
595
|
items: list[TwitterFollowingItem] = Field(
|
|
606
596
|
description="Followed-account records, normalized to a compact shape. Populated whenever the provider has data for the entity."
|
|
607
597
|
)
|
|
@@ -610,9 +600,6 @@ class TwitterFollowingData(BaseModel):
|
|
|
610
600
|
alias="nextCursor",
|
|
611
601
|
description="Opaque cursor for the next page of followed accounts, or null when there are no more. Pass it back as cursor to continue.",
|
|
612
602
|
)
|
|
613
|
-
posts: int | None = Field(
|
|
614
|
-
default=None, description="Number of posts the account has published."
|
|
615
|
-
)
|
|
616
603
|
|
|
617
604
|
|
|
618
605
|
class TwitterFollowingItem(BaseModel):
|
|
@@ -623,14 +610,25 @@ class TwitterFollowingItem(BaseModel):
|
|
|
623
610
|
description="URL of the account's profile image (may be empty). Populated whenever the provider has data for the entity.",
|
|
624
611
|
)
|
|
625
612
|
bio: str = Field(description="The account's profile bio/description.")
|
|
613
|
+
created_utc: float | None = Field(
|
|
614
|
+
default=None,
|
|
615
|
+
alias="createdUtc",
|
|
616
|
+
description="UTC epoch timestamp in seconds (Unix time) the account was created. Multiply by 1000 for a JS Date in milliseconds.",
|
|
617
|
+
)
|
|
626
618
|
followers: int = Field(description="How many followers this account has.")
|
|
627
619
|
following: int = Field(description="How many accounts this account follows.")
|
|
620
|
+
id: str | None = Field(
|
|
621
|
+
default=None, description="Numeric X user id of the account, as a string."
|
|
622
|
+
)
|
|
628
623
|
location: str | None = Field(
|
|
629
624
|
default=None, description="The account's self-reported location (may be empty)."
|
|
630
625
|
)
|
|
631
626
|
name: str = Field(
|
|
632
627
|
description="The account's display name. Populated whenever the provider has data for the entity."
|
|
633
628
|
)
|
|
629
|
+
posts: int | None = Field(
|
|
630
|
+
default=None, description="Number of posts the account has published."
|
|
631
|
+
)
|
|
634
632
|
username: str = Field(
|
|
635
633
|
description="The account's @ handle, without the @ prefix. Populated whenever the provider has data for the entity."
|
|
636
634
|
)
|
|
@@ -692,11 +690,6 @@ class TwitterProfileData(BaseModel):
|
|
|
692
690
|
class TwitterRepliesData(BaseModel):
|
|
693
691
|
model_config = ConfigDict(populate_by_name=True)
|
|
694
692
|
|
|
695
|
-
conversation_id: str | None = Field(
|
|
696
|
-
default=None,
|
|
697
|
-
alias="conversationId",
|
|
698
|
-
description="Id of the conversation the reply belongs to, as a string.",
|
|
699
|
-
)
|
|
700
693
|
items: list[TwitterRepliesItem] = Field(
|
|
701
694
|
description="Reply records for the requested post. Populated whenever the provider has data for the entity."
|
|
702
695
|
)
|
|
@@ -720,6 +713,11 @@ class TwitterRepliesItem(BaseModel):
|
|
|
720
713
|
alias="authorName",
|
|
721
714
|
description="Display name of the reply's author. Empty when the upstream omits it.",
|
|
722
715
|
)
|
|
716
|
+
conversation_id: str | None = Field(
|
|
717
|
+
default=None,
|
|
718
|
+
alias="conversationId",
|
|
719
|
+
description="Id of the conversation the reply belongs to, as a string.",
|
|
720
|
+
)
|
|
723
721
|
created_utc: float = Field(
|
|
724
722
|
alias="createdUtc",
|
|
725
723
|
description="UTC epoch timestamp in seconds (Unix time). Multiply by 1000 for a JS Date in milliseconds.",
|
|
@@ -785,6 +783,19 @@ class TwitterRepliesMedia(BaseModel):
|
|
|
785
783
|
class TwitterSearchData(BaseModel):
|
|
786
784
|
model_config = ConfigDict(populate_by_name=True)
|
|
787
785
|
|
|
786
|
+
items: list[TwitterSearchItem] = Field(
|
|
787
|
+
description="Tweet records: text, author profile, timestamp, and engagement metrics (likes, retweets, replies, views). Populated whenever the provider has data for the entity."
|
|
788
|
+
)
|
|
789
|
+
next_cursor: str | None = Field(
|
|
790
|
+
default=None,
|
|
791
|
+
alias="nextCursor",
|
|
792
|
+
description="Opaque cursor for the next page of search results, or null when there are no more. Pass it back as cursor to continue.",
|
|
793
|
+
)
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
class TwitterSearchItem(BaseModel):
|
|
797
|
+
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
798
|
+
|
|
788
799
|
author_followers: int | None = Field(
|
|
789
800
|
default=None,
|
|
790
801
|
alias="authorFollowers",
|
|
@@ -800,19 +811,6 @@ class TwitterSearchData(BaseModel):
|
|
|
800
811
|
alias="authorImage",
|
|
801
812
|
description="Avatar image URL of the account that posted.",
|
|
802
813
|
)
|
|
803
|
-
items: list[TwitterSearchItem] = Field(
|
|
804
|
-
description="Tweet records: text, author profile, timestamp, and engagement metrics (likes, retweets, replies, views). Populated whenever the provider has data for the entity."
|
|
805
|
-
)
|
|
806
|
-
next_cursor: str | None = Field(
|
|
807
|
-
default=None,
|
|
808
|
-
alias="nextCursor",
|
|
809
|
-
description="Opaque cursor for the next page of search results, or null when there are no more. Pass it back as cursor to continue.",
|
|
810
|
-
)
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
class TwitterSearchItem(BaseModel):
|
|
814
|
-
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
815
|
-
|
|
816
814
|
author_name: str | None = Field(
|
|
817
815
|
default=None,
|
|
818
816
|
alias="authorName",
|
|
@@ -988,6 +986,25 @@ class TwitterThreadData(BaseModel):
|
|
|
988
986
|
model_config = ConfigDict(populate_by_name=True)
|
|
989
987
|
|
|
990
988
|
author: TwitterThreadAuthor
|
|
989
|
+
complete: bool = Field(
|
|
990
|
+
description="Whether the provider reached the end of the self-thread without hitting its internal cap."
|
|
991
|
+
)
|
|
992
|
+
conversation_id: str = Field(
|
|
993
|
+
alias="conversationId",
|
|
994
|
+
description="Conversation ID shared by the self-thread tweets. Populated whenever the provider has data for the entity.",
|
|
995
|
+
)
|
|
996
|
+
thread_length: int = Field(
|
|
997
|
+
alias="threadLength",
|
|
998
|
+
description="Number of tweets returned in the self-thread.",
|
|
999
|
+
)
|
|
1000
|
+
tweets: list[TwitterThreadTweet] = Field(
|
|
1001
|
+
description="Ordered self-thread tweets. Replies from other users are excluded. Populated whenever the provider has data for the entity."
|
|
1002
|
+
)
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
class TwitterThreadAuthor(BaseModel):
|
|
1006
|
+
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
1007
|
+
|
|
991
1008
|
avatar_url: str | None = Field(
|
|
992
1009
|
default=None, alias="avatarUrl", description="Avatar image URL of the author."
|
|
993
1010
|
)
|
|
@@ -999,13 +1016,6 @@ class TwitterThreadData(BaseModel):
|
|
|
999
1016
|
alias="blueVerified",
|
|
1000
1017
|
description="Whether the author carries an X blue verification badge.",
|
|
1001
1018
|
)
|
|
1002
|
-
complete: bool = Field(
|
|
1003
|
-
description="Whether the provider reached the end of the self-thread without hitting its internal cap."
|
|
1004
|
-
)
|
|
1005
|
-
conversation_id: str = Field(
|
|
1006
|
-
alias="conversationId",
|
|
1007
|
-
description="Conversation ID shared by the self-thread tweets. Populated whenever the provider has data for the entity.",
|
|
1008
|
-
)
|
|
1009
1019
|
cover_url: str | None = Field(
|
|
1010
1020
|
default=None,
|
|
1011
1021
|
alias="coverUrl",
|
|
@@ -1022,15 +1032,17 @@ class TwitterThreadData(BaseModel):
|
|
|
1022
1032
|
following: int | None = Field(
|
|
1023
1033
|
default=None, description="Number of accounts the author follows."
|
|
1024
1034
|
)
|
|
1035
|
+
handle: str = Field(
|
|
1036
|
+
description="Populated whenever the provider has data for the entity."
|
|
1037
|
+
)
|
|
1038
|
+
id: str = Field(
|
|
1039
|
+
description="Populated whenever the provider has data for the entity."
|
|
1040
|
+
)
|
|
1025
1041
|
location: str | None = Field(
|
|
1026
1042
|
default=None, description="Location text on the author's profile."
|
|
1027
1043
|
)
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
description="Number of tweets returned in the self-thread.",
|
|
1031
|
-
)
|
|
1032
|
-
tweets: list[TwitterThreadTweet] = Field(
|
|
1033
|
-
description="Ordered self-thread tweets. Replies from other users are excluded. Populated whenever the provider has data for the entity."
|
|
1044
|
+
name: str = Field(
|
|
1045
|
+
description="Populated whenever the provider has data for the entity."
|
|
1034
1046
|
)
|
|
1035
1047
|
url: str | None = Field(
|
|
1036
1048
|
default=None, description="Canonical X profile URL of the thread's author."
|
|
@@ -1041,20 +1053,6 @@ class TwitterThreadData(BaseModel):
|
|
|
1041
1053
|
)
|
|
1042
1054
|
|
|
1043
1055
|
|
|
1044
|
-
class TwitterThreadAuthor(BaseModel):
|
|
1045
|
-
model_config = ConfigDict(extra="allow")
|
|
1046
|
-
|
|
1047
|
-
handle: str = Field(
|
|
1048
|
-
description="Populated whenever the provider has data for the entity."
|
|
1049
|
-
)
|
|
1050
|
-
id: str = Field(
|
|
1051
|
-
description="Populated whenever the provider has data for the entity."
|
|
1052
|
-
)
|
|
1053
|
-
name: str = Field(
|
|
1054
|
-
description="Populated whenever the provider has data for the entity."
|
|
1055
|
-
)
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
1056
|
class TwitterThreadTweet(BaseModel):
|
|
1059
1057
|
model_config = ConfigDict(extra="allow", populate_by_name=True)
|
|
1060
1058
|
|
|
@@ -1161,7 +1159,6 @@ class TwitterTrendsData(BaseModel):
|
|
|
1161
1159
|
alias="locationId",
|
|
1162
1160
|
description="Resolved Yahoo WOEID used by X, exposed as a stable location identifier. Populated whenever the provider has data for the entity.",
|
|
1163
1161
|
)
|
|
1164
|
-
url: str | None = Field(default=None, description="X search URL for the trend.")
|
|
1165
1162
|
|
|
1166
1163
|
|
|
1167
1164
|
class TwitterTrendsItem(BaseModel):
|
|
@@ -1184,6 +1181,7 @@ class TwitterTrendsItem(BaseModel):
|
|
|
1184
1181
|
rank: int = Field(
|
|
1185
1182
|
description="One-based position in X's trend ranking. Populated whenever the provider has data for the entity. Minimum: 1."
|
|
1186
1183
|
)
|
|
1184
|
+
url: str | None = Field(default=None, description="X search URL for the trend.")
|
|
1187
1185
|
|
|
1188
1186
|
|
|
1189
1187
|
class TwitterTweetData(BaseModel):
|
|
@@ -368,10 +368,6 @@ class YoutubeVideoTranscriptInput(TypedDict, total=False):
|
|
|
368
368
|
"""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."""
|
|
369
369
|
preferLatencyUnderMs: NotRequired[int]
|
|
370
370
|
"""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."""
|
|
371
|
-
requireFields: NotRequired[
|
|
372
|
-
list[Literal["durationSeconds", "segments", "startSeconds", "text"]]
|
|
373
|
-
]
|
|
374
|
-
"""Only use sources that return these fields. The cheapest source returns the transcript as one block of text and no timings, so name any of these to be served by a source that carries timed segments instead."""
|
|
375
371
|
source: NotRequired[list[str]]
|
|
376
372
|
"""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`."""
|
|
377
373
|
url: NotRequired[str]
|
|
@@ -1160,6 +1156,11 @@ class YoutubeVideoCommentsComment(BaseModel):
|
|
|
1160
1156
|
description="Populated whenever the provider has data for the entity.",
|
|
1161
1157
|
)
|
|
1162
1158
|
replies: int
|
|
1159
|
+
replies_continuation_token: str | None = Field(
|
|
1160
|
+
default=None,
|
|
1161
|
+
alias="repliesContinuationToken",
|
|
1162
|
+
description="Token for this comment's replies. Pass it as continuationToken to youtube.comment_replies. Absent when the comment has no replies or the serving source does not return one.",
|
|
1163
|
+
)
|
|
1163
1164
|
text: str = Field(
|
|
1164
1165
|
description="Populated whenever the provider has data for the entity."
|
|
1165
1166
|
)
|
|
@@ -1845,7 +1846,7 @@ class YoutubeNamespace:
|
|
|
1845
1846
|
Fetch a YouTube video or Short's metadata (title, channel, views, likes,
|
|
1846
1847
|
duration, publish date) by URL or ID.
|
|
1847
1848
|
|
|
1848
|
-
Price: $0.
|
|
1849
|
+
Price: $0.0008 per request.
|
|
1849
1850
|
|
|
1850
1851
|
Example:
|
|
1851
1852
|
res = client.youtube.video(url="https://www.youtube.com/watch?v=dQw4w9WgXcQ")
|
|
@@ -2485,7 +2486,7 @@ class AsyncYoutubeNamespace:
|
|
|
2485
2486
|
Fetch a YouTube video or Short's metadata (title, channel, views, likes,
|
|
2486
2487
|
duration, publish date) by URL or ID.
|
|
2487
2488
|
|
|
2488
|
-
Price: $0.
|
|
2489
|
+
Price: $0.0008 per request.
|
|
2489
2490
|
|
|
2490
2491
|
Example:
|
|
2491
2492
|
res = client.youtube.video(url="https://www.youtube.com/watch?v=dQw4w9WgXcQ")
|
|
@@ -324,7 +324,7 @@ class ZillowSearchItem(BaseModel):
|
|
|
324
324
|
)
|
|
325
325
|
city: str | None = None
|
|
326
326
|
currency: str | None = Field(
|
|
327
|
-
default=None, description="ISO currency code of the price (e.g.
|
|
327
|
+
default=None, description="ISO currency code of the price (e.g. USD)."
|
|
328
328
|
)
|
|
329
329
|
days_on_zillow: int | None = Field(
|
|
330
330
|
default=None,
|
|
@@ -364,7 +364,7 @@ class ZillowSearchItem(BaseModel):
|
|
|
364
364
|
property_type: str | None = Field(
|
|
365
365
|
default=None,
|
|
366
366
|
alias="propertyType",
|
|
367
|
-
description="Property type (e.g.
|
|
367
|
+
description="Property type (e.g. SINGLE_FAMILY, CONDO, TOWNHOUSE).",
|
|
368
368
|
)
|
|
369
369
|
rent_zestimate: float | None = Field(
|
|
370
370
|
default=None,
|
|
@@ -373,7 +373,8 @@ class ZillowSearchItem(BaseModel):
|
|
|
373
373
|
)
|
|
374
374
|
state: str | None = Field(default=None, description="Two-letter state code.")
|
|
375
375
|
status: str | None = Field(
|
|
376
|
-
default=None,
|
|
376
|
+
default=None,
|
|
377
|
+
description="Listing status (e.g. FOR_SALE, FOR_RENT, RECENTLY_SOLD).",
|
|
377
378
|
)
|
|
378
379
|
street_address: str | None = Field(
|
|
379
380
|
default=None,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|