Amagi API 文档 - v5.6.3
    正在准备搜索索引...

    函数 createBoundXiaohongshuApi

    • 创建绑定了cookie的小红书API对象

      参数

      返回 {
          getHomeFeed: <M extends TypeMode>(
              options: Omit<
                  {
                      methodType: "首页推荐数据";
                      cursor_score?: string;
                      num?: number;
                      refresh_type?: number;
                      note_index?: number;
                      category?: string;
                      search_key?: string;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<HomeFeed, M>>>;
          getNote: <M extends TypeMode>(
              options: Omit<
                  { methodType: "单个笔记数据"; note_id: string; xsec_token: string },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<OneNote, M>>>;
          getComments: <M extends TypeMode>(
              options: Omit<
                  {
                      methodType: "评论数据";
                      note_id: string;
                      cursor?: string;
                      xsec_token: string;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<NoteComments, M>>>;
          getUser: <M extends TypeMode>(
              options: Omit<{ methodType: "用户数据"; user_id: string }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<XiaohongshuUserProfile, M>>>;
          getUserNotes: <M extends TypeMode>(
              options: Omit<
                  {
                      methodType: "用户笔记数据";
                      user_id: string;
                      cursor?: string;
                      num?: number;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<any, M>>>;
          getSearchNotes: <M extends TypeMode>(
              options: Omit<
                  {
                      methodType: "搜索笔记";
                      keyword: string;
                      page?: number;
                      page_size?: number;
                      sort?: SearchSortType;
                      note_type?: SearchNoteType;
                  },
                  "methodType",
              > & { typeMode?: TypeMode } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<SearchNotes, M>>>;
          getEmojiList: <M extends TypeMode>(
              options: Omit<{ methodType: "表情列表" }, "methodType"> & {
                  typeMode?: TypeMode;
              } & { typeMode?: M },
          ) => Promise<ApiResponse<ConditionalReturnType<XiaohongshuEmojiList, M>>>;
      }

      绑定了cookie的小红书API对象,调用时不需要再传递cookie

      • getHomeFeed: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "首页推荐数据";
                    cursor_score?: string;
                    num?: number;
                    refresh_type?: number;
                    note_index?: number;
                    category?: string;
                    search_key?: string;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<HomeFeed, M>>>

        获取首页推荐数据

      • getNote: <M extends TypeMode>(
            options: Omit<
                { methodType: "单个笔记数据"; note_id: string; xsec_token: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<OneNote, M>>>

        获取单个笔记数据

      • getComments: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "评论数据";
                    note_id: string;
                    cursor?: string;
                    xsec_token: string;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<NoteComments, M>>>

        获取评论数据

      • getUser: <M extends TypeMode>(
            options: Omit<{ methodType: "用户数据"; user_id: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<XiaohongshuUserProfile, M>>>

        获取用户数据

      • getUserNotes: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "用户笔记数据";
                    user_id: string;
                    cursor?: string;
                    num?: number;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<any, M>>>

        获取用户笔记数据

      • getSearchNotes: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "搜索笔记";
                    keyword: string;
                    page?: number;
                    page_size?: number;
                    sort?: SearchSortType;
                    note_type?: SearchNoteType;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<SearchNotes, M>>>

        获取搜索笔记数据

      • getEmojiList: <M extends TypeMode>(
            options: Omit<{ methodType: "表情列表" }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
        ) => Promise<ApiResponse<ConditionalReturnType<XiaohongshuEmojiList, M>>>

        获取表情列表数据