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

    变量 xiaohongshu常量

    xiaohongshu: {
        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 },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<HomeFeed, M>>>;
        getNote: <M extends TypeMode>(
            options: Omit<
                { methodType: "单个笔记数据"; note_id: string; xsec_token: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => 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 },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<NoteComments, M>>>;
        getUser: <M extends TypeMode>(
            options: Omit<{ methodType: "用户数据"; user_id: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<XiaohongshuUserProfile, M>>>;
        getUserNotes: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "用户笔记数据";
                    user_id: string;
                    cursor?: string;
                    num?: number;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => 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 },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<SearchNotes, M>>>;
        getEmojiList: <M extends TypeMode>(
            options: Omit<{ methodType: "表情列表" }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<XiaohongshuEmojiList, M>>>;
    } = ...

    封装了所有小红书相关的API请求,采用对象化的方式组织。

    提供了一系列方法,用于与小红书相关的 API 进行交互。

    每个方法都接受参数和 Cookie,返回 Promise,解析为统一格式的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 },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<HomeFeed, M>>>

      获取首页推荐数据

    • getNote: <M extends TypeMode>(
          options: Omit<
              { methodType: "单个笔记数据"; note_id: string; xsec_token: string },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => 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 },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<NoteComments, M>>>

      获取评论数据

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

      获取用户数据

    • getUserNotes: <M extends TypeMode>(
          options: Omit<
              {
                  methodType: "用户笔记数据";
                  user_id: string;
                  cursor?: string;
                  num?: number;
              },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => 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 },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<SearchNotes, M>>>

      获取搜索笔记数据

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

      获取表情列表数据