api.md

Shared Types

from influship.types import CreatorBasic, ProfileSummary

Health

Types:

from influship.types import HealthCheckResponse

Methods:

• client.health.check() -> HealthCheckResponse

Creators

Types:

from influship.types import (
    CreatorRetrieveResponse,
    CreatorAutocompleteResponse,
    CreatorLookalikeResponse,
    CreatorMatchResponse,
)

Methods:

• client.creators.retrieve(id, **params) -> CreatorRetrieveResponse
• client.creators.autocomplete(**params) -> CreatorAutocompleteResponse
• client.creators.lookalike(**params) -> SyncBodyCursor[CreatorLookalikeResponse]
• client.creators.match(**params) -> CreatorMatchResponse

Search

Types:

from influship.types import MatchInfo, SearchCreateResponse, SearchRetrieveResponse

Methods:

• client.search.create(**params) -> SearchCreateResponse
• client.search.retrieve(id, **params) -> SyncQueryCursor[SearchRetrieveResponse]

Profiles

Types:

from influship.types import (
    ProfileActivity,
    ProfileGrowth,
    ProfileMetrics,
    ProfileResponseData,
    ProfileGetResponse,
    ProfileLookupResponse,
)

Methods:

• client.profiles.get(username, *, platform) -> ProfileGetResponse
• client.profiles.lookup(**params) -> ProfileLookupResponse

Posts

Types:

from influship.types import PostListResponse

Methods:

• client.posts.list(**params) -> SyncQueryCursor[PostListResponse]

Raw

Instagram

Types:

from influship.types.raw import (
    InstagramSinglePostResponse,
    InstagramTranscriptResponse,
    RawScraperError,
    InstagramGetPostResponse,
    InstagramGetPostsResponse,
    InstagramGetProfileResponse,
    InstagramGetTranscriptResponse,
    InstagramGetTranscriptsResponse,
)

Methods:

• client.raw.instagram.get_post(shortcode) -> InstagramGetPostResponse
• client.raw.instagram.get_posts(**params) -> InstagramGetPostsResponse
• client.raw.instagram.get_profile(username, **params) -> InstagramGetProfileResponse
• client.raw.instagram.get_transcript(shortcode, **params) -> InstagramGetTranscriptResponse
• client.raw.instagram.get_transcripts(**params) -> InstagramGetTranscriptsResponse

Youtube

Types:

from influship.types.raw import (
    TranscriptSegment,
    YoutubeGetChannelResponse,
    YoutubeGetChannelTranscriptsResponse,
    YoutubeGetTranscriptResponse,
    YoutubeSearchResponse,
)

Methods:

• client.raw.youtube.get_channel(handle, **params) -> YoutubeGetChannelResponse
• client.raw.youtube.get_channel_transcripts(handle, **params) -> YoutubeGetChannelTranscriptsResponse
• client.raw.youtube.get_transcript(video_id, **params) -> YoutubeGetTranscriptResponse
• client.raw.youtube.search(**params) -> YoutubeSearchResponse