igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Variable musicSearchFeedConst

    musicSearchFeed: {
        (
            initial: string,
        ): Effect<
            {
                checkpoint: Effect<
                    WithOptionalDefaults<
                        MusicSearchFeedInput,
                        {
                            browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                            searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                        },
                    >,
                    never,
                    never,
                >;
                next: Effect<
                    FeedPage<
                        {
                            alacorn_session_id: string;
                            items: {
                                metadata: MusicSearchFeedResponseMetadata;
                                track: {
                                    alacorn_session_id: string;
                                    allows_saving: boolean;
                                    audio_asset_id: string;
                                    audio_cluster_id: string;
                                    browse_session_id: string;
                                    cover_artwork_thumbnail_uri: string;
                                    cover_artwork_uri: string;
                                    dash_manifest: string;
                                    display_artist: string;
                                    duration_in_ms: number;
                                    fast_start_progressive_download_url: string;
                                    has_lyrics: boolean;
                                    highlight_start_times_in_ms: number[];
                                    id: string;
                                    is_eligible_for_audio_effects: boolean;
                                    is_eligible_for_vinyl_sticker: boolean;
                                    is_explicit: boolean;
                                    licensed_music_subtype: string;
                                    progressive_download_url: string;
                                    song_monetization_info: string;
                                    subtitle: string;
                                    title: string;
                                };
                            }[];
                            licensed_music_eligibility_state: string;
                            page_info: MusicSearchFeedResponsePageInfo;
                            search_error_codes: unknown[];
                            status: string;
                            status_code: string;
                        },
                        {
                            metadata: MusicSearchFeedResponseMetadata;
                            track: {
                                alacorn_session_id: string;
                                allows_saving: boolean;
                                audio_asset_id: string;
                                audio_cluster_id: string;
                                browse_session_id: string;
                                cover_artwork_thumbnail_uri: string;
                                cover_artwork_uri: string;
                                dash_manifest: string;
                                display_artist: string;
                                duration_in_ms: number;
                                fast_start_progressive_download_url: string;
                                has_lyrics: boolean;
                                highlight_start_times_in_ms: number[];
                                id: string;
                                is_eligible_for_audio_effects: boolean;
                                is_eligible_for_vinyl_sticker: boolean;
                                is_explicit: boolean;
                                licensed_music_subtype: string;
                                progressive_download_url: string;
                                song_monetization_info: string;
                                subtitle: string;
                                title: string;
                            };
                        },
                    >,
                    IgApiError
                    | RequestError
                    | ParseError
                    | TransportError,
                    PlainJsonApiHttp | MobileDevice,
                >;
            },
            FeedCheckpointDecodeError,
        >;
        (
            initial: WithOptionalDefaults<
                MusicSearchFeedInput,
                {
                    browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                    searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                },
            >,
        ): Effect<
            {
                checkpoint: Effect<
                    WithOptionalDefaults<
                        MusicSearchFeedInput,
                        {
                            browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                            searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                        },
                    >,
                    never,
                    never,
                >;
                next: Effect<
                    FeedPage<
                        {
                            alacorn_session_id: string;
                            items: {
                                metadata: MusicSearchFeedResponseMetadata;
                                track: {
                                    alacorn_session_id: string;
                                    allows_saving: boolean;
                                    audio_asset_id: string;
                                    audio_cluster_id: string;
                                    browse_session_id: string;
                                    cover_artwork_thumbnail_uri: string;
                                    cover_artwork_uri: string;
                                    dash_manifest: string;
                                    display_artist: string;
                                    duration_in_ms: number;
                                    fast_start_progressive_download_url: string;
                                    has_lyrics: boolean;
                                    highlight_start_times_in_ms: number[];
                                    id: string;
                                    is_eligible_for_audio_effects: boolean;
                                    is_eligible_for_vinyl_sticker: boolean;
                                    is_explicit: boolean;
                                    licensed_music_subtype: string;
                                    progressive_download_url: string;
                                    song_monetization_info: string;
                                    subtitle: string;
                                    title: string;
                                };
                            }[];
                            licensed_music_eligibility_state: string;
                            page_info: MusicSearchFeedResponsePageInfo;
                            search_error_codes: unknown[];
                            status: string;
                            status_code: string;
                        },
                        {
                            metadata: MusicSearchFeedResponseMetadata;
                            track: {
                                alacorn_session_id: string;
                                allows_saving: boolean;
                                audio_asset_id: string;
                                audio_cluster_id: string;
                                browse_session_id: string;
                                cover_artwork_thumbnail_uri: string;
                                cover_artwork_uri: string;
                                dash_manifest: string;
                                display_artist: string;
                                duration_in_ms: number;
                                fast_start_progressive_download_url: string;
                                has_lyrics: boolean;
                                highlight_start_times_in_ms: number[];
                                id: string;
                                is_eligible_for_audio_effects: boolean;
                                is_eligible_for_vinyl_sticker: boolean;
                                is_explicit: boolean;
                                licensed_music_subtype: string;
                                progressive_download_url: string;
                                song_monetization_info: string;
                                subtitle: string;
                                title: string;
                            };
                        },
                    >,
                    IgApiError
                    | RequestError
                    | ParseError
                    | TransportError,
                    PlainJsonApiHttp | MobileDevice,
                >;
            },
        >;
    } = ...

    Type Declaration

      • (
            initial: string,
        ): Effect<
            {
                checkpoint: Effect<
                    WithOptionalDefaults<
                        MusicSearchFeedInput,
                        {
                            browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                            searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                        },
                    >,
                    never,
                    never,
                >;
                next: Effect<
                    FeedPage<
                        {
                            alacorn_session_id: string;
                            items: {
                                metadata: MusicSearchFeedResponseMetadata;
                                track: {
                                    alacorn_session_id: string;
                                    allows_saving: boolean;
                                    audio_asset_id: string;
                                    audio_cluster_id: string;
                                    browse_session_id: string;
                                    cover_artwork_thumbnail_uri: string;
                                    cover_artwork_uri: string;
                                    dash_manifest: string;
                                    display_artist: string;
                                    duration_in_ms: number;
                                    fast_start_progressive_download_url: string;
                                    has_lyrics: boolean;
                                    highlight_start_times_in_ms: number[];
                                    id: string;
                                    is_eligible_for_audio_effects: boolean;
                                    is_eligible_for_vinyl_sticker: boolean;
                                    is_explicit: boolean;
                                    licensed_music_subtype: string;
                                    progressive_download_url: string;
                                    song_monetization_info: string;
                                    subtitle: string;
                                    title: string;
                                };
                            }[];
                            licensed_music_eligibility_state: string;
                            page_info: MusicSearchFeedResponsePageInfo;
                            search_error_codes: unknown[];
                            status: string;
                            status_code: string;
                        },
                        {
                            metadata: MusicSearchFeedResponseMetadata;
                            track: {
                                alacorn_session_id: string;
                                allows_saving: boolean;
                                audio_asset_id: string;
                                audio_cluster_id: string;
                                browse_session_id: string;
                                cover_artwork_thumbnail_uri: string;
                                cover_artwork_uri: string;
                                dash_manifest: string;
                                display_artist: string;
                                duration_in_ms: number;
                                fast_start_progressive_download_url: string;
                                has_lyrics: boolean;
                                highlight_start_times_in_ms: number[];
                                id: string;
                                is_eligible_for_audio_effects: boolean;
                                is_eligible_for_vinyl_sticker: boolean;
                                is_explicit: boolean;
                                licensed_music_subtype: string;
                                progressive_download_url: string;
                                song_monetization_info: string;
                                subtitle: string;
                                title: string;
                            };
                        },
                    >,
                    IgApiError
                    | RequestError
                    | ParseError
                    | TransportError,
                    PlainJsonApiHttp | MobileDevice,
                >;
            },
            FeedCheckpointDecodeError,
        >
      • Parameters

        • initial: string

        Returns Effect<
            {
                checkpoint: Effect<
                    WithOptionalDefaults<
                        MusicSearchFeedInput,
                        {
                            browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                            searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                        },
                    >,
                    never,
                    never,
                >;
                next: Effect<
                    FeedPage<
                        {
                            alacorn_session_id: string;
                            items: {
                                metadata: MusicSearchFeedResponseMetadata;
                                track: {
                                    alacorn_session_id: string;
                                    allows_saving: boolean;
                                    audio_asset_id: string;
                                    audio_cluster_id: string;
                                    browse_session_id: string;
                                    cover_artwork_thumbnail_uri: string;
                                    cover_artwork_uri: string;
                                    dash_manifest: string;
                                    display_artist: string;
                                    duration_in_ms: number;
                                    fast_start_progressive_download_url: string;
                                    has_lyrics: boolean;
                                    highlight_start_times_in_ms: number[];
                                    id: string;
                                    is_eligible_for_audio_effects: boolean;
                                    is_eligible_for_vinyl_sticker: boolean;
                                    is_explicit: boolean;
                                    licensed_music_subtype: string;
                                    progressive_download_url: string;
                                    song_monetization_info: string;
                                    subtitle: string;
                                    title: string;
                                };
                            }[];
                            licensed_music_eligibility_state: string;
                            page_info: MusicSearchFeedResponsePageInfo;
                            search_error_codes: unknown[];
                            status: string;
                            status_code: string;
                        },
                        {
                            metadata: MusicSearchFeedResponseMetadata;
                            track: {
                                alacorn_session_id: string;
                                allows_saving: boolean;
                                audio_asset_id: string;
                                audio_cluster_id: string;
                                browse_session_id: string;
                                cover_artwork_thumbnail_uri: string;
                                cover_artwork_uri: string;
                                dash_manifest: string;
                                display_artist: string;
                                duration_in_ms: number;
                                fast_start_progressive_download_url: string;
                                has_lyrics: boolean;
                                highlight_start_times_in_ms: number[];
                                id: string;
                                is_eligible_for_audio_effects: boolean;
                                is_eligible_for_vinyl_sticker: boolean;
                                is_explicit: boolean;
                                licensed_music_subtype: string;
                                progressive_download_url: string;
                                song_monetization_info: string;
                                subtitle: string;
                                title: string;
                            };
                        },
                    >,
                    IgApiError
                    | RequestError
                    | ParseError
                    | TransportError,
                    PlainJsonApiHttp | MobileDevice,
                >;
            },
            FeedCheckpointDecodeError,
        >

      • (
            initial: WithOptionalDefaults<
                MusicSearchFeedInput,
                {
                    browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                    searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                },
            >,
        ): Effect<
            {
                checkpoint: Effect<
                    WithOptionalDefaults<
                        MusicSearchFeedInput,
                        {
                            browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                            searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                        },
                    >,
                    never,
                    never,
                >;
                next: Effect<
                    FeedPage<
                        {
                            alacorn_session_id: string;
                            items: {
                                metadata: MusicSearchFeedResponseMetadata;
                                track: {
                                    alacorn_session_id: string;
                                    allows_saving: boolean;
                                    audio_asset_id: string;
                                    audio_cluster_id: string;
                                    browse_session_id: string;
                                    cover_artwork_thumbnail_uri: string;
                                    cover_artwork_uri: string;
                                    dash_manifest: string;
                                    display_artist: string;
                                    duration_in_ms: number;
                                    fast_start_progressive_download_url: string;
                                    has_lyrics: boolean;
                                    highlight_start_times_in_ms: number[];
                                    id: string;
                                    is_eligible_for_audio_effects: boolean;
                                    is_eligible_for_vinyl_sticker: boolean;
                                    is_explicit: boolean;
                                    licensed_music_subtype: string;
                                    progressive_download_url: string;
                                    song_monetization_info: string;
                                    subtitle: string;
                                    title: string;
                                };
                            }[];
                            licensed_music_eligibility_state: string;
                            page_info: MusicSearchFeedResponsePageInfo;
                            search_error_codes: unknown[];
                            status: string;
                            status_code: string;
                        },
                        {
                            metadata: MusicSearchFeedResponseMetadata;
                            track: {
                                alacorn_session_id: string;
                                allows_saving: boolean;
                                audio_asset_id: string;
                                audio_cluster_id: string;
                                browse_session_id: string;
                                cover_artwork_thumbnail_uri: string;
                                cover_artwork_uri: string;
                                dash_manifest: string;
                                display_artist: string;
                                duration_in_ms: number;
                                fast_start_progressive_download_url: string;
                                has_lyrics: boolean;
                                highlight_start_times_in_ms: number[];
                                id: string;
                                is_eligible_for_audio_effects: boolean;
                                is_eligible_for_vinyl_sticker: boolean;
                                is_explicit: boolean;
                                licensed_music_subtype: string;
                                progressive_download_url: string;
                                song_monetization_info: string;
                                subtitle: string;
                                title: string;
                            };
                        },
                    >,
                    IgApiError
                    | RequestError
                    | ParseError
                    | TransportError,
                    PlainJsonApiHttp | MobileDevice,
                >;
            },
        >
      • Parameters

        • initial: WithOptionalDefaults<
              MusicSearchFeedInput,
              {
                  browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                  searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
              },
          >

        Returns Effect<
            {
                checkpoint: Effect<
                    WithOptionalDefaults<
                        MusicSearchFeedInput,
                        {
                            browseSessionId: `${string}-${string}-${string}-${string}-${string}`;
                            searchSessionId: `${string}-${string}-${string}-${string}-${string}`;
                        },
                    >,
                    never,
                    never,
                >;
                next: Effect<
                    FeedPage<
                        {
                            alacorn_session_id: string;
                            items: {
                                metadata: MusicSearchFeedResponseMetadata;
                                track: {
                                    alacorn_session_id: string;
                                    allows_saving: boolean;
                                    audio_asset_id: string;
                                    audio_cluster_id: string;
                                    browse_session_id: string;
                                    cover_artwork_thumbnail_uri: string;
                                    cover_artwork_uri: string;
                                    dash_manifest: string;
                                    display_artist: string;
                                    duration_in_ms: number;
                                    fast_start_progressive_download_url: string;
                                    has_lyrics: boolean;
                                    highlight_start_times_in_ms: number[];
                                    id: string;
                                    is_eligible_for_audio_effects: boolean;
                                    is_eligible_for_vinyl_sticker: boolean;
                                    is_explicit: boolean;
                                    licensed_music_subtype: string;
                                    progressive_download_url: string;
                                    song_monetization_info: string;
                                    subtitle: string;
                                    title: string;
                                };
                            }[];
                            licensed_music_eligibility_state: string;
                            page_info: MusicSearchFeedResponsePageInfo;
                            search_error_codes: unknown[];
                            status: string;
                            status_code: string;
                        },
                        {
                            metadata: MusicSearchFeedResponseMetadata;
                            track: {
                                alacorn_session_id: string;
                                allows_saving: boolean;
                                audio_asset_id: string;
                                audio_cluster_id: string;
                                browse_session_id: string;
                                cover_artwork_thumbnail_uri: string;
                                cover_artwork_uri: string;
                                dash_manifest: string;
                                display_artist: string;
                                duration_in_ms: number;
                                fast_start_progressive_download_url: string;
                                has_lyrics: boolean;
                                highlight_start_times_in_ms: number[];
                                id: string;
                                is_eligible_for_audio_effects: boolean;
                                is_eligible_for_vinyl_sticker: boolean;
                                is_explicit: boolean;
                                licensed_music_subtype: string;
                                progressive_download_url: string;
                                song_monetization_info: string;
                                subtitle: string;
                                title: string;
                            };
                        },
                    >,
                    IgApiError
                    | RequestError
                    | ParseError
                    | TransportError,
                    PlainJsonApiHttp | MobileDevice,
                >;
            },
        >