getanyapi 0.1.0__py3-none-any.whl

getanyapi/platforms/sec.py

@@ -0,0 +1,118 @@
+# Generated - do not edit. Regenerate with: pnpm generate
+"""Generated namespace module for the sec platform."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import NotRequired, Required, TypedDict, Unpack
+
+from ..types import RequestOptions, RunResult
+
+if TYPE_CHECKING:
+    from .._async_client import AsyncAnyAPI
+    from .._client import AnyAPI
+
+
+class SecFilingsInput(TypedDict, total=False):
+    """Input for SEC EDGAR Filings."""
+
+    dateFrom: NotRequired[str]
+    """Only return filings filed on or after this date, in YYYY-MM-DD format (e.g. 2025-01-01)."""
+    dateTo: NotRequired[str]
+    """Only return filings filed on or before this date, in YYYY-MM-DD format (e.g. 2026-06-01)."""
+    form: NotRequired[str]
+    """Filter filings by SEC form type (e.g. 10-K, 10-Q, 8-K, 4, DEF 14A, S-1, 13F-HR); omit for all forms."""
+    limit: NotRequired[int]
+    """Maximum number of filings to return (1-25, default 25). You are billed per result returned, so a lower limit costs less. Range: 1 to 25."""
+    ticker: Required[str]
+    """Company stock ticker symbol, e.g. AAPL, MSFT, or TSLA."""
+
+
+class SecFilingsData(BaseModel):
+    items: list[SecFilingsItem] = Field(
+        description="Filing records: company and CIK, form type, filing date, accession number, and document links."
+    )
+
+
+class SecFilingsItem(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    accession_number: str = Field(
+        alias="accessionNumber",
+        description="SEC accession number uniquely identifying the filing.",
+    )
+    cik: str | None = Field(
+        default=None,
+        description="SEC Central Index Key for the filer. Present whenever the upstream returns this record.",
+    )
+    company_name: str | None = Field(
+        default=None,
+        alias="companyName",
+        description="Present whenever the upstream returns this record.",
+    )
+    filing_date: str | None = Field(
+        default=None,
+        alias="filingDate",
+        description="Date the filing was filed, YYYY-MM-DD. Present whenever the upstream returns this record.",
+    )
+    form: str | None = Field(
+        default=None,
+        description="SEC form type, e.g. 10-K, 10-Q, 8-K. Present whenever the upstream returns this record.",
+    )
+    url: str = Field(
+        description="Direct link to the primary filing document on sec.gov."
+    )
+
+
+class SecNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AnyAPI") -> None:
+        self._client = client
+
+    def filings(
+        self, *, options: RequestOptions | None = None, **input: Unpack[SecFilingsInput]
+    ) -> RunResult[SecFilingsData]:
+        """SEC EDGAR Filings
+
+        List a public company's SEC EDGAR filings - form type, filing date,
+        accession number, and document links - by ticker, company name, or CIK, with
+        optional form-type and date filters, billed per request in USD.
+
+        Price: $0.002 per request plus $0.0004 per result.
+
+        Example:
+            res = client.sec.filings(limit=3, ticker="AAPL")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "sec.filings", dict(input), options
+        )
+        return RunResult[SecFilingsData].model_validate(raw)
+
+
+class AsyncSecNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AsyncAnyAPI") -> None:
+        self._client = client
+
+    async def filings(
+        self, *, options: RequestOptions | None = None, **input: Unpack[SecFilingsInput]
+    ) -> RunResult[SecFilingsData]:
+        """SEC EDGAR Filings
+
+        List a public company's SEC EDGAR filings - form type, filing date,
+        accession number, and document links - by ticker, company name, or CIK, with
+        optional form-type and date filters, billed per request in USD.
+
+        Price: $0.002 per request plus $0.0004 per result.
+
+        Example:
+            res = client.sec.filings(limit=3, ticker="AAPL")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "sec.filings", dict(input), options
+        )
+        return RunResult[SecFilingsData].model_validate(raw)

getanyapi/platforms/semrush.py

@@ -0,0 +1,358 @@
+# Generated - do not edit. Regenerate with: pnpm generate
+"""Generated namespace module for the semrush platform."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import NotRequired, Required, TypedDict, Unpack
+
+from ..types import RequestOptions, RunResult
+
+if TYPE_CHECKING:
+    from .._async_client import AsyncAnyAPI
+    from .._client import AnyAPI
+
+
+class SemrushKeywordsInput(TypedDict, total=False):
+    """Input for Semrush Keyword Research."""
+
+    database: NotRequired[str]
+    """Two-letter Semrush regional database that scopes the metrics (e.g. us, uk, de). Default: us."""
+    keyword: Required[str]
+    """The search term to research (e.g. "best running shoes")."""
+
+
+class SemrushOverviewInput(TypedDict, total=False):
+    """Input for Semrush Domain Overview."""
+
+    database: NotRequired[str]
+    """Two-letter Semrush regional database that scopes the metrics (e.g. us, uk, de). Default: us."""
+    domain: Required[str]
+    """The domain to analyze (e.g. ahrefs.com)."""
+    includeMoz: NotRequired[bool]
+    """Add Moz Domain Authority and Spam Score to the response. Default: false."""
+
+
+class SemrushKeywordsData(BaseModel):
+    items: list[SemrushKeywordsItem] = Field(
+        description="Keyword-research records: search volume, CPC, competition, keyword difficulty, plus related keywords and question keywords for the researched term."
+    )
+
+
+class SemrushKeywordsItem(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    competition: float | None = Field(
+        default=None, description="Paid-search competition density, 0 to 1."
+    )
+    cpc_usd: float | None = Field(
+        default=None, alias="cpcUsd", description="Average cost per click in USD."
+    )
+    database: str | None = Field(
+        default=None,
+        description="Two-letter Semrush regional database the metrics are scoped to.",
+    )
+    intents: list[str] | None = Field(
+        default=None,
+        description="Search-intent labels for the keyword (e.g. commercial, informational). Present whenever the upstream returns this record.",
+    )
+    keyword: str = Field(description="The researched search term.")
+    keyword_difficulty: int | None = Field(
+        default=None,
+        alias="keywordDifficulty",
+        description="Semrush Keyword Difficulty, 0 to 100.",
+    )
+    organic_results_count: int | None = Field(
+        default=None,
+        alias="organicResultsCount",
+        description="Number of organic results Google returns for the keyword.",
+    )
+    questions: list[SemrushKeywordsQuestion] | None = Field(
+        default=None,
+        description="Question-phrased keyword variations with their own volume and difficulty. Present whenever the upstream returns this record.",
+    )
+    referring_domains_median: int | None = Field(
+        default=None,
+        alias="referringDomainsMedian",
+        description="Median number of referring domains across the ranking pages.",
+    )
+    related_keywords: list[SemrushKeywordsRelatedKeyword] | None = Field(
+        default=None,
+        alias="relatedKeywords",
+        description="Related keyword suggestions with their own volume and difficulty. Present whenever the upstream returns this record.",
+    )
+    search_volume: int | None = Field(
+        default=None,
+        alias="searchVolume",
+        description="Average monthly search volume in the selected database.",
+    )
+
+
+class SemrushKeywordsQuestion(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    keyword: str = Field(description="The question keyword.")
+    keyword_difficulty: int | None = Field(
+        default=None,
+        alias="keywordDifficulty",
+        description="Semrush Keyword Difficulty for the question keyword, 0 to 100.",
+    )
+    search_volume: int | None = Field(
+        default=None,
+        alias="searchVolume",
+        description="Average monthly search volume for the question keyword.",
+    )
+
+
+class SemrushKeywordsRelatedKeyword(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    keyword: str = Field(description="The related keyword.")
+    keyword_difficulty: int | None = Field(
+        default=None,
+        alias="keywordDifficulty",
+        description="Semrush Keyword Difficulty for the related keyword, 0 to 100.",
+    )
+    search_volume: int | None = Field(
+        default=None,
+        alias="searchVolume",
+        description="Average monthly search volume for the related keyword.",
+    )
+
+
+class SemrushOverviewData(BaseModel):
+    items: list[SemrushOverviewItem] = Field(
+        description="Domain overview records: Authority Score, organic and paid traffic, keyword and backlink counts, top country, and the domain's top organic keywords."
+    )
+
+
+class SemrushOverviewItem(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    ai_visibility: int | None = Field(
+        default=None,
+        alias="aiVisibility",
+        description="Semrush AI visibility metric for the domain.",
+    )
+    authority_score: int | None = Field(
+        default=None,
+        alias="authorityScore",
+        description="Semrush Authority Score, 0-100.",
+    )
+    backlinks: int | None = Field(
+        default=None, description="Total number of backlinks pointing at the domain."
+    )
+    database: str | None = Field(
+        default=None,
+        description="Two-letter Semrush regional database the metrics are scoped to.",
+    )
+    domain: str = Field(description="The analyzed domain.")
+    follow_backlinks: int | None = Field(
+        default=None,
+        alias="followBacklinks",
+        description="Number of dofollow backlinks.",
+    )
+    moz_domain_authority: int | None = Field(
+        default=None,
+        alias="mozDomainAuthority",
+        description="Moz Domain Authority, 0-100 (only when includeMoz is true).",
+    )
+    moz_spam_score: str | None = Field(
+        default=None,
+        alias="mozSpamScore",
+        description="Moz Spam Score as a percentage string (only when includeMoz is true).",
+    )
+    nofollow_backlinks: int | None = Field(
+        default=None,
+        alias="nofollowBacklinks",
+        description="Number of nofollow backlinks.",
+    )
+    organic_keywords: int | None = Field(
+        default=None,
+        alias="organicKeywords",
+        description="Number of keywords the domain ranks for organically.",
+    )
+    organic_traffic: int | None = Field(
+        default=None,
+        alias="organicTraffic",
+        description="Estimated monthly organic search traffic.",
+    )
+    organic_traffic_cost_usd: float | None = Field(
+        default=None,
+        alias="organicTrafficCostUsd",
+        description="Estimated USD value of the organic traffic.",
+    )
+    paid_keywords: int | None = Field(
+        default=None,
+        alias="paidKeywords",
+        description="Number of keywords the domain bids on.",
+    )
+    paid_traffic: int | None = Field(
+        default=None,
+        alias="paidTraffic",
+        description="Estimated monthly paid search traffic.",
+    )
+    paid_traffic_cost_usd: float | None = Field(
+        default=None,
+        alias="paidTrafficCostUsd",
+        description="Estimated USD value of the paid traffic.",
+    )
+    referring_domains: int | None = Field(
+        default=None,
+        alias="referringDomains",
+        description="Number of unique domains linking to the domain.",
+    )
+    top_country: str | None = Field(
+        default=None,
+        alias="topCountry",
+        description="Two-letter code of the country sending the most traffic.",
+    )
+    top_country_traffic: int | None = Field(
+        default=None,
+        alias="topCountryTraffic",
+        description="Estimated monthly traffic from the top country.",
+    )
+    top_keywords: list[SemrushOverviewTopKeyword] | None = Field(
+        default=None,
+        alias="topKeywords",
+        description="The domain's top organic keywords with position, volume, and value. Present whenever the upstream returns this record.",
+    )
+    total_traffic: int | None = Field(
+        default=None,
+        alias="totalTraffic",
+        description="Estimated total monthly traffic across organic and paid.",
+    )
+
+
+class SemrushOverviewTopKeyword(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    cpc_usd: float | None = Field(
+        default=None, alias="cpcUsd", description="Average cost per click in USD."
+    )
+    intents: list[str] | None = Field(
+        default=None, description="Search intents associated with the keyword."
+    )
+    keyword: str = Field(description="The organic keyword.")
+    keyword_difficulty: int | None = Field(
+        default=None,
+        alias="keywordDifficulty",
+        description="Semrush Keyword Difficulty, 0-100.",
+    )
+    position: int | None = Field(
+        default=None, description="Current SERP position for this keyword."
+    )
+    search_volume: int | None = Field(
+        default=None,
+        alias="searchVolume",
+        description="Monthly search volume for this keyword.",
+    )
+    traffic: int | None = Field(
+        default=None,
+        description="Estimated monthly traffic this keyword drives to the domain.",
+    )
+    url: str | None = Field(default=None, description="The ranking URL on the domain.")
+
+
+class SemrushNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AnyAPI") -> None:
+        self._client = client
+
+    def keywords(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SemrushKeywordsInput],
+    ) -> RunResult[SemrushKeywordsData]:
+        """Semrush Keyword Research
+
+        Semrush keyword research for any term: monthly search volume, CPC,
+        competition, keyword difficulty, plus related keywords and question
+        keywords. Transparent per-request USD pricing.
+
+        Price: $0.015 per result.
+
+        Example:
+            res = client.semrush.keywords(database="us", keyword="best running shoes")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "semrush.keywords", dict(input), options
+        )
+        return RunResult[SemrushKeywordsData].model_validate(raw)
+
+    def overview(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SemrushOverviewInput],
+    ) -> RunResult[SemrushOverviewData]:
+        """Semrush Domain Overview
+
+        a Semrush SEO overview for any domain: Authority Score, organic and paid
+        traffic, keyword and backlink counts, top country, and the domain's top
+        organic keywords. Transparent per-request USD pricing.
+
+        Price: $0.015 per result.
+
+        Example:
+            res = client.semrush.overview(database="us", domain="ahrefs.com")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "semrush.overview", dict(input), options
+        )
+        return RunResult[SemrushOverviewData].model_validate(raw)
+
+
+class AsyncSemrushNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AsyncAnyAPI") -> None:
+        self._client = client
+
+    async def keywords(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SemrushKeywordsInput],
+    ) -> RunResult[SemrushKeywordsData]:
+        """Semrush Keyword Research
+
+        Semrush keyword research for any term: monthly search volume, CPC,
+        competition, keyword difficulty, plus related keywords and question
+        keywords. Transparent per-request USD pricing.
+
+        Price: $0.015 per result.
+
+        Example:
+            res = client.semrush.keywords(database="us", keyword="best running shoes")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "semrush.keywords", dict(input), options
+        )
+        return RunResult[SemrushKeywordsData].model_validate(raw)
+
+    async def overview(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SemrushOverviewInput],
+    ) -> RunResult[SemrushOverviewData]:
+        """Semrush Domain Overview
+
+        a Semrush SEO overview for any domain: Authority Score, organic and paid
+        traffic, keyword and backlink counts, top country, and the domain's top
+        organic keywords. Transparent per-request USD pricing.
+
+        Price: $0.015 per result.
+
+        Example:
+            res = client.semrush.overview(database="us", domain="ahrefs.com")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "semrush.overview", dict(input), options
+        )
+        return RunResult[SemrushOverviewData].model_validate(raw)

getanyapi/platforms/snapchat.py

@@ -0,0 +1,146 @@
+# Generated - do not edit. Regenerate with: pnpm generate
+"""Generated namespace module for the snapchat platform."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Required, TypedDict, Unpack
+
+from ..types import RequestOptions, RunResult
+
+if TYPE_CHECKING:
+    from .._async_client import AsyncAnyAPI
+    from .._client import AnyAPI
+
+
+class SnapchatProfileInput(TypedDict, total=False):
+    """Input for Snapchat Profile."""
+
+    username: Required[str]
+    """The Snapchat username or profile URL to look up (e.g. fcbarcelona or https://www.snapchat.com/add/fcbarcelona)."""
+
+
+class SnapchatProfileData(BaseModel):
+    items: list[SnapchatProfileItem] = Field(
+        description="Profile records: public profile URL, handle, display name, bio, subscriber count, avatar, and recent public stories."
+    )
+
+
+class SnapchatProfileItem(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    avatar_url: str | None = Field(
+        default=None,
+        alias="avatarUrl",
+        description="URL of the profile avatar image. Present whenever the upstream returns this record.",
+    )
+    bio: str | None = Field(
+        default=None,
+        description="The profile's public bio / description text. Present whenever the upstream returns this record.",
+    )
+    display_name: str | None = Field(
+        default=None,
+        alias="displayName",
+        description="The profile's public display name. Present whenever the upstream returns this record.",
+    )
+    handle: str | None = Field(
+        default=None, description="Present whenever the upstream returns this record."
+    )
+    stories: list[SnapchatProfileStorie] | None = Field(
+        default=None,
+        description="Recent public stories, each with its snaps (media items).",
+    )
+    subscribers: int | None = Field(
+        default=None, description="Public subscriber count."
+    )
+    url: str
+
+
+class SnapchatProfileStorie(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: str | None = Field(default=None, description="Story identifier.")
+    snaps: list[SnapchatProfileSnap] | None = Field(
+        default=None, description="The snaps (media items) in this story."
+    )
+    story_title: str | None = Field(
+        default=None, alias="storyTitle", description="Story title."
+    )
+    thumbnail_url: str | None = Field(
+        default=None, alias="thumbnailUrl", description="Story thumbnail image URL."
+    )
+
+
+class SnapchatProfileSnap(BaseModel):
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: str | None = Field(default=None, description="Snap identifier.")
+    media_url: str | None = Field(
+        default=None, alias="mediaUrl", description="Full-resolution media URL."
+    )
+    preview_url: str | None = Field(
+        default=None, alias="previewUrl", description="Preview/thumbnail media URL."
+    )
+    timestamp: str | None = Field(
+        default=None, description="Snap timestamp (ISO 8601)."
+    )
+
+
+class SnapchatNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AnyAPI") -> None:
+        self._client = client
+
+    def profile(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SnapchatProfileInput],
+    ) -> RunResult[SnapchatProfileData]:
+        """Snapchat Profile
+
+        Fetch a Snapchat user's public profile by username - display name, bio,
+        subscriber count, and recent public content - with transparent per-request
+        USD pricing.
+
+        Price: $0.001 per request plus $0.002 per result.
+
+        Example:
+            res = client.snapchat.profile(username="nasa")
+        """
+        raw = self._client._run_raw(  # pyright: ignore[reportPrivateUsage]
+            "snapchat.profile", dict(input), options
+        )
+        return RunResult[SnapchatProfileData].model_validate(raw)
+
+
+class AsyncSnapchatNamespace:
+    """Typed methods for this platform. Attached lazily to the client."""
+
+    def __init__(self, client: "AsyncAnyAPI") -> None:
+        self._client = client
+
+    async def profile(
+        self,
+        *,
+        options: RequestOptions | None = None,
+        **input: Unpack[SnapchatProfileInput],
+    ) -> RunResult[SnapchatProfileData]:
+        """Snapchat Profile
+
+        Fetch a Snapchat user's public profile by username - display name, bio,
+        subscriber count, and recent public content - with transparent per-request
+        USD pricing.
+
+        Price: $0.001 per request plus $0.002 per result.
+
+        Example:
+            res = client.snapchat.profile(username="nasa")
+        """
+        raw = await self._client._arun_raw(  # pyright: ignore[reportPrivateUsage]
+            "snapchat.profile", dict(input), options
+        )
+        return RunResult[SnapchatProfileData].model_validate(raw)