{ "openapi": "3.1.0", "info": { "title": "HikerAPI REST", "description": "Instagram API", "termsOfService": "https://hikerapi.com/help/terms-of-service", "license": { "name": "Pricing", "url": "https://hikerapi.com/pricing" }, "version": "1.7.7" }, "paths": { "/a2/user": { "get": { "tags": [ "User Profile" ], "summary": "User", "description": "Get user object", "operationId": "a2_user", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response A2 User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gql/comments/chunk": { "get": { "tags": [ "Comments" ], "summary": "Media Comments Chunk", "description": "Get comments on a media", "operationId": "gql_comments_chunk", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "title": "Sort Order", "default": "recent" } }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response Gql Comments Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\ncomments, end_cursor = await cl.comments_chunk_gql(\n media_id=\"3162273595027945978\", end_cursor=None\n)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nend_cursor = None\nwhile True:\n items, end_cursor = cl.comments_chunk_gql(\"3162273595027945978\", end_cursor=end_cursor)\n items_list.extend(items)\n if not end_cursor:\n break\n ", "label": "Python" } ], "required": false } }, "/gql/comments": { "get": { "tags": [ "Comments" ], "summary": "WARNING: Preferable to use /gql/comments/chunk", "description": "Get comments on a media", "operationId": "gql_comments", "deprecated": true, "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "title": "Sort Order", "default": "recent" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Amount" } }, { "name": "max_requests", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Max Requests" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Gql Comments" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.comments_gql(media_id=\"3162273595027945978\", amount=10)\n", "label": "Python" } ], "required": false } }, "/gql/comments/threaded/chunk": { "get": { "tags": [ "Comments" ], "summary": "Media Comments Threaded Chunk", "description": "Get threaded comments for comment", "operationId": "gql_comments_threaded_chunk", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Comment Id" } }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response Gql Comments Threaded Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\ncomments, end_cursor = cl.comments_threaded_chunk_gql(comment_id=\"2321157652140500761\", end_cursor=None)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nend_cursor = None\nwhile True:\n items, end_cursor = cl.comments_threaded_chunk_gql(\"3162273595027945978\", end_cursor=end_cursor)\n items_list.extend(items)\n if not end_cursor:\n break\n ", "label": "Python" } ], "required": false } }, "/gql/comments/threaded": { "get": { "tags": [ "Comments" ], "summary": "WARNING: Preferable to use /gql/comments/chunk", "description": "Get threaded comments for comment", "operationId": "gql_comments_threaded", "deprecated": true, "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Comment Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Gql Comments Threaded" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\ncomments = await cl.comments_threaded_gql(comment_id=\"17868057941916088\", amount=10)\n", "label": "Python" } ], "required": false } }, "/gql/comment/likers/chunk": { "get": { "tags": [ "Comments" ], "summary": "Comment Likers Chunk", "description": "Get likers on a comment", "operationId": "gql_comment_likers_chunk", "parameters": [ { "name": "comment_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Comment Id" } }, { "name": "media_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Media Id" }, "deprecated": true }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "End Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response Gql Comment Likers Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nlikers, end_cursor = cl.comment_likers_chunk_gql(media_id=\"3162273595027945978\", end_cursor=None)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nend_cursor = None\nwhile True:\n items, end_cursor = cl.comment_likers_chunk_gql(\"3162273595027945978\", end_cursor=end_cursor)\n items_list.extend(items)\n if not end_cursor:\n break\n ", "label": "Python" } ], "required": false } }, "/gql/comment/likers": { "get": { "tags": [ "Comments" ], "summary": "WARNING: Preferable to use /gql/comment/likers/chunk", "description": "Get likers on a comment", "operationId": "gql_comment_likers", "deprecated": true, "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Gql Comment Likers" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.comment_likers_gql(media_id=\"3162273595027945978\", amount=10)\n", "label": "Python" } ], "required": false } }, "/gql/topsearch": { "get": { "tags": [ "Comments" ], "summary": "Topsearch", "description": "Search top content by keyword (GraphQL TopSerpQuery)", "operationId": "gql_topsearch", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Gql Topsearch" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gql/media/likers": { "get": { "tags": [ "Post Details" ], "summary": "Media Likers", "description": "Get likers on a media (paging is unavailable on this endpoint)", "operationId": "gql_media_likers", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Gql Media Likers" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nlikers = await cl.media_likers_gql(media_id=\"3162273595027945978\")\n", "label": "Python" } ], "required": false } }, "/gql/media/usertags": { "get": { "tags": [ "Post Details" ], "summary": "Returns users tagged in the video. You can pass up to 10 media ids", "description": "Returns users tagged in the video. You can pass up to 10 media ids", "operationId": "gql_media_usertags", "parameters": [ { "name": "media_ids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "title": "Media Ids" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_usertags_gql(media_id=\"3162273595027945978\")\n", "label": "Python" } ], "required": false } }, "/gql/user/by/id": { "get": { "tags": [ "User Profile" ], "summary": "User By Id", "description": "Get user object by id", "operationId": "gql_user_by_id", "deprecated": true, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gql/user/by/username": { "get": { "tags": [ "User Profile" ], "summary": "Get user object by username (one request required)", "description": "Get user object by username", "operationId": "gql_user_by_username", "deprecated": true, "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gql/user/related/profiles": { "get": { "tags": [ "User Profile" ], "summary": "Prefer using v2/user/suggested/profiles as this endpoint will be completely deprecated soon", "description": "Get related profiles by user id", "operationId": "gql_user_related_profiles", "deprecated": true, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response Gql User Related Profiles" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_related_profiles_gql(id=\"123123\")\n", "label": "Python" } ], "required": false } }, "/gql/user/followers": { "get": { "tags": [ "User Profile" ], "summary": "WARNING: Use /v2/user/followers. Get a user followers (one request is required for every 46 followers)", "description": "Get followers users", "operationId": "gql_user_followers", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 46, "title": "Amount" } } ], "responses": { "200": { "description": "List of users (followers)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response Gql User Followers" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_followers_gql(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/gql/user/followers/chunk": { "get": { "tags": [ "User Profile" ], "summary": "Get a user followers (one request required)", "description": "Get part (one page) of followers users with cursor", "operationId": "gql_user_followers_chunk", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "List of users (followers)", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/UserShortWithReel" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response Gql User Followers Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nfollowers, end_cursor = await cl.user_followers_chunk_gql(\n user_id=\"123123\", end_cursor=None\n)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nend_cursor = None\nwhile True:\n items, end_cursor = cl.user_followers_chunk_gql(\"123123\", end_cursor=end_cursor)\n items_list.extend(items)\n if not end_cursor:\n break\n ", "label": "Python" } ], "required": false } }, "/gql/user/following": { "get": { "tags": [ "User Profile" ], "summary": "WARNING: Use /v2/user/following. Get a user following (one request is required for every 46 following)", "description": "Get following users", "operationId": "gql_user_following", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Amount" } } ], "responses": { "200": { "description": "List of users (following)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response Gql User Following" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_following_gql(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/gql/user/following/chunk": { "get": { "tags": [ "User Profile" ], "summary": "Get a user following (one request required)", "description": "Get part (one page) of following users with cursor", "operationId": "gql_user_following_chunk", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "List of users (following)", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response Gql User Following Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nfollowings, end_cursor = await cl.user_following_chunk_gql(\n user_id=\"123123\", end_cursor=None\n)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nend_cursor = None\nwhile True:\n items, end_cursor = cl.user_following_chunk_gql(\"123123\", end_cursor=end_cursor)\n items_list.extend(items)\n if not end_cursor:\n break\n ", "label": "Python" } ], "required": false } }, "/gql/user/reposts": { "get": { "tags": [ "User Profile" ], "summary": "Get user's reposted content", "description": "Get user media reposts", "operationId": "gql_user_reposts", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "repost_next_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Repost Next Max Id" } }, { "name": "flat", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Flatten nested response into simple items list", "default": false, "title": "Flat" }, "description": "Flatten nested response into simple items list" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_reposts_gql(user_id=\"4255960887\")", "label": "Python" } ], "required": false } }, "/gql/user/clips": { "get": { "tags": [ "User Profile" ], "summary": "Returns the user's short video posts (reels).", "description": "Get user clips", "operationId": "gql_user_clips", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Max Id" } }, { "name": "sort_by_views", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Sort By Views" } }, { "name": "flat", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Flatten nested media objects into a single list", "default": false, "title": "Flat" }, "description": "Flatten nested media objects into a single list" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedia = await cl.user_clips_gql(target_user_id=\"26064198596\")\n", "label": "Python" } ], "required": false } }, "/gql/user/medias": { "get": { "tags": [ "Top 5", "User Profile" ], "summary": "Returns the user medias", "description": "Get user medias", "operationId": "gql_user_medias", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "profile_grid_items_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Profile Grid Items Cursor" } }, { "name": "flat", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Flatten nested media objects into a single list", "default": false, "title": "Flat" }, "description": "Flatten nested media objects into a single list" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_medias_gql (\n user_id=\"123123\", profile_grid_items_cursor=None\n)\n", "label": "Python" } ], "required": false } }, "/gql/user/web_profile_info": { "get": { "tags": [ "User Profile" ], "summary": "Get user profile info GraphQL", "description": "Get user profile info by user id (GraphQL web_profile_info)", "operationId": "gql_user_web_profile_info", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_web_profile_info_gql(user_id=\"95561\")\n", "label": "Python" } ], "required": false } }, "/v1/user/by/id": { "get": { "tags": [ "User Profile" ], "summary": "User By Id", "description": "Get user object by id", "operationId": "v1_user_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_by_id_v1(id=\"123123\")\n", "label": "Python" } ], "required": false } }, "/v1/user/by/username": { "get": { "tags": [ "User Profile" ], "summary": "Get user object by username (one request required). If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get user object by username", "operationId": "v1_user_by_username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_by_username_v1(username=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v1/user/by/url": { "get": { "tags": [ "User Profile" ], "summary": "Get user object by URL (one request required)", "description": "Get user object by URL", "operationId": "v1_user_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_by_url_v1(url=\"https://www.ins...ram.com/thesun\")\n", "label": "Python" } ], "required": false } }, "/v1/user/about": { "get": { "tags": [ "User Profile" ], "summary": "User About", "description": "Get user object by id", "operationId": "v1_user_about", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/About" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/user/medias": { "get": { "tags": [ "Legacy" ], "summary": "WARNING: Use /v2/user/medias (better) or /v1/user/medias/chunk. Get user medias - first page", "description": "Get user medias", "operationId": "v1_user_medias", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 33, "title": "Amount" } } ], "responses": { "200": { "description": "List of medias", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 User Medias" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_medias_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/medias/chunk": { "get": { "tags": [ "User Profile" ], "summary": "User Medias Chunk", "description": "Get part of user medias with cursor", "operationId": "v1_user_medias_chunk", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 User Medias Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedias, end_cursor = await cl.user_medias_chunk_v1(\n user_id=\"123123\", end_cursor=None\n)\n", "label": "Python" } ], "required": false } }, "/v1/user/medias/pinned": { "get": { "tags": [ "User Profile" ], "summary": "Get pinned medias", "description": "Get user medias", "operationId": "v1_user_medias_pinned", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 33, "title": "Amount" } } ], "responses": { "200": { "description": "List of medias", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 User Medias Pinned" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_medias_pinned_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/clips": { "get": { "tags": [ "Legacy" ], "summary": "WARNING: Use v1/user/clips/chunk. Get user clips - first page", "description": "Get user clips", "operationId": "v1_user_clips", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Amount" } } ], "responses": { "200": { "description": "List of clips", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 User Clips" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_clips_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/clips/chunk": { "get": { "tags": [ "User Profile" ], "summary": "User Clips Chunk", "description": "Get part of user clips with cursor \n\nThe response includes trial publications\nhttps://help.instagram.com/1013292530224018 \n\nTrial publications have no \"reshare_count\" field if you need to filter them", "operationId": "v1_user_clips_chunk", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 User Clips Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedias, end_cursor = await cl.user_clips_chunk_v1(user_id=\"123123\", end_cursor=None)\n", "label": "Python" } ], "required": false } }, "/v1/user/videos": { "get": { "tags": [ "Legacy" ], "summary": "Prefer using /v2/user/clips or /v2/user/medias instead", "description": "Get user videos", "operationId": "v1_user_videos", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Amount" } } ], "responses": { "200": { "description": "List of videos", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 User Videos" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_videos_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/videos/chunk": { "get": { "tags": [ "Legacy" ], "summary": "Prefer using /v2/user/clips or /v2/user/medias instead", "description": "Get part of user videos with cursor (default 50 media per request)", "operationId": "v1_user_videos_chunk", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "title": "End Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 User Videos Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nvideos, end_cursor = await cl.user_videos_chunk_v1(\n user_id=\"123123\", end_cursor=None\n)\n", "label": "Python" } ], "required": false } }, "/v1/user/tag/medias": { "get": { "tags": [ "Legacy" ], "summary": "Usertag Medias", "description": "Prefer to use /v2/user/tag/medias", "operationId": "v1_user_tag_medias", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 User Tag Medias" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/user/tag/medias/chunk": { "get": { "tags": [ "User Profile" ], "summary": "Usertag Medias Chunk", "description": "Get usertag medias", "operationId": "v1_user_tag_medias_chunk", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 User Tag Medias Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedias, max_id = await cl.user_tag_medias_chunk_v1(user_id=\"123123\", max_id=None)\n", "label": "Python" } ], "required": false } }, "/v1/user/stories": { "get": { "tags": [ "User Profile" ], "summary": "User Stories", "description": "Get user stories", "operationId": "v1_user_stories", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Amount" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Story" }, "title": "Response V1 User Stories" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_stories_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/stories/by/username": { "get": { "tags": [ "User Profile" ], "summary": "If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get user stories", "operationId": "v1_user_stories_by_username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Amount" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Story" }, "title": "Response V1 User Stories By Username" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/user/highlights": { "get": { "tags": [ "User Profile" ], "summary": "User Highlights", "description": "Get user highlights", "operationId": "v1_user_highlights", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Amount" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Highlight" }, "title": "Response V1 User Highlights" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_highlights_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/highlights/by/username": { "get": { "tags": [ "User Profile" ], "summary": "If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get user highlights by username", "operationId": "v1_user_highlights_by_username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Amount" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Highlight" }, "title": "Response V1 User Highlights By Username" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_highlights_by_username_v1(username=\"sun\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/search/followers": { "get": { "tags": [ "User Profile" ], "summary": "Search Followers", "description": "Search users by followers", "operationId": "v1_user_search_followers", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response V1 User Search Followers" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_search_followers_v1(user_id=\"123123\", query=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v1/user/search/following": { "get": { "tags": [ "User Profile" ], "summary": "Search Following", "description": "Search users by following users", "operationId": "v1_user_search_following", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response V1 User Search Following" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_search_following_v1(user_id=\"123123\", query=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v1/user/following": { "get": { "tags": [ "Legacy" ], "summary": "WARNING: Use /v2/user/following or /v1/user/following/chunk. Get first page user following", "description": "Get following users", "operationId": "v1_user_following", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "title": "Amount" } } ], "responses": { "200": { "description": "List of users (followings)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response V1 User Following" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_following_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/following/chunk": { "get": { "tags": [ "User Profile" ], "summary": "Get a user following (one request required)", "description": "Get part (one page) of following users with cursor", "operationId": "v1_user_following_chunk", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Max Id" } } ], "responses": { "200": { "description": "List of users (following)", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 User Following Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nfollowings, max_id = await cl.user_following_chunk_v1(\n user_id=\"123123\", max_id=None\n)\n", "label": "Python" } ], "required": false } }, "/v1/user/followers": { "get": { "tags": [ "Legacy" ], "summary": "WARNING: Use /v2/user/followers of /v1/user/followers/chunk. Get first page user followers", "description": "Get followers users", "operationId": "v1_user_followers", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "title": "Amount" } } ], "responses": { "200": { "description": "List of users (followers)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response V1 User Followers" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_followers_v1(user_id=\"123123\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/user/followers/chunk": { "get": { "tags": [ "User Profile" ], "summary": "Get a user followers (one request required)", "description": "Get part (one page) of followers users with cursor", "operationId": "v1_user_followers_chunk", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Max Id" } } ], "responses": { "200": { "description": "List of users (followers)", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 User Followers Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nfollowers, max_id = await cl.user_followers_chunk_v1(\n user_id=\"123123\", max_id=None\n)\n", "label": "Python" } ], "required": false } }, "/v1/user/web_profile_info": { "get": { "tags": [ "User Profile" ], "summary": "WARNING: Deprecated. Instagram returns ~90% false UserNotFound since Feb 2, 2026. Use /gql/user/web_profile_info instead (accepts numeric user ID, much more reliable).", "operationId": "v1_user_web_profile_info", "deprecated": true, "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V1 User Web Profile Info" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_web_profile_info_v1(username=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v1/user/guides": { "get": { "tags": [ "Legacy" ], "summary": "User Guides V1", "description": "Get user guides", "operationId": "v1_user_guides", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Guide" }, "title": "Response V1 User Guides" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_guides_v1(user_id=\"123123\")\n", "label": "Python" } ], "required": false } }, "/v1/media/by/id": { "get": { "tags": [ "Post Details" ], "summary": "Media By Id", "description": "Get media object", "operationId": "v1_media_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_id_v1(id=\"123123\")\n", "label": "Python" } ], "required": false } }, "/v1/media/by/code": { "get": { "tags": [ "Post Details" ], "summary": "Media By Code", "description": "Get media object", "operationId": "v1_media_by_code", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_code_v1(code=\"CvipxSKPPn6\")\n", "label": "Python" } ], "required": false } }, "/v1/media/by/url": { "get": { "tags": [ "Post Details" ], "summary": "Attention! Use with (https://ins...ram.com/p/CA2aJYrg6cZ/)", "description": "Get media object", "operationId": "v1_media_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Media" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_url_v1(url=\"https://ins...ram.com/p/CA2aJYrg6cZ/\")\n", "label": "Python" } ], "required": false } }, "/v1/media/insight": { "get": { "tags": [ "Post Details" ], "summary": "Insights Media", "description": "Get media insight", "operationId": "v1_media_insight", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "title": "Response V1 Media Insight" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_insight_v1(media_id=\"3162273595027945978\")\n", "label": "Python" } ], "required": false } }, "/v1/media/comments/chunk": { "get": { "tags": [ "Post Details", "Comments" ], "summary": "Get media comments (one request return 15 comments)", "description": "Get comments on a media", "operationId": "v1_media_comments_chunk", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "min_id", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Min Id" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Max Id" } }, { "name": "can_support_threading", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Can Support Threading" } } ], "responses": { "200": { "description": "List of comments", "content": { "application/json": { "schema": { "type": "array", "items": {}, "title": "Response V1 Media Comments Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\ncomments, max_id, _ = await cl.media_comments_chunk_v1(\n id=\"3169346321139418017\", max_id=None\n)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nmax_id = None\nwhile True:\n items, max_id = cl.media_comments_chunk_v1(\"3169346321139418017\", max_id=max_id)\n items_list.extend(items)\n if not max_id:\n break\n ", "label": "Python" } ], "required": false } }, "/v1/media/comments": { "get": { "tags": [ "Legacy" ], "summary": "Get media comments (one request is required for every 20 comments)", "description": "Get comments on a media", "operationId": "v1_media_comments", "deprecated": true, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Amount" } } ], "responses": { "200": { "description": "List of comments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" }, "title": "Response V1 Media Comments" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/media/likers": { "get": { "tags": [ "Post Details" ], "summary": "Media Likers", "description": "Get user's likers", "operationId": "v1_media_likers", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response V1 Media Likers" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_likers_v1(id=\"3169346321139418017\")\n", "label": "Python" } ], "required": false } }, "/v1/media/user": { "get": { "tags": [ "Post Details" ], "summary": "Media User", "description": "Get author of the media", "operationId": "v1_media_user", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserShort" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_user_v1(media_id=\"3162273595027945978\")\n", "label": "Python" } ], "required": false } }, "/v1/media/oembed": { "get": { "tags": [ "Post Details" ], "summary": "Media Oembed", "description": "Return info about media and user from post URL", "operationId": "v1_media_oembed", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaOembed" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_oembed_v1(url=\"need_url_here\")\n", "label": "Python" } ], "required": false } }, "/v1/media/download/photo": { "get": { "tags": [ "Legacy" ], "summary": "Photo Download", "description": "Download photo using media pk", "operationId": "v1_media_download_photo", "deprecated": true, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/media/download/photo/by/url": { "get": { "tags": [ "Legacy" ], "summary": "Photo Download By Url", "description": "Download photo using URL", "operationId": "v1_media_download_photo_by_url", "deprecated": true, "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/media/download/video": { "get": { "tags": [ "Legacy" ], "summary": "Video Download", "description": "Download video using media pk", "operationId": "v1_media_download_video", "deprecated": true, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/media/download/video/by/url": { "get": { "tags": [ "Legacy" ], "summary": "Video Download By Url", "description": "Download video using URL", "operationId": "v1_media_download_video_by_url", "deprecated": true, "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/media/code/from/pk": { "get": { "tags": [ "Post Details" ], "summary": "Media Code From Pk", "description": "Get media code from pk", "operationId": "v1_media_code_from_pk", "parameters": [ { "name": "pk", "in": "query", "required": true, "schema": { "type": "string", "title": "Pk" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response V1 Media Code From Pk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_code_from_pk_v1(pk=\"3162273595027945978\")\n", "label": "Python" } ], "required": false } }, "/v1/media/pk/from/code": { "get": { "tags": [ "Post Details" ], "summary": "Media Pk From Code", "description": "Get media pk from code", "operationId": "v1_media_pk_from_code", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response V1 Media Pk From Code" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_pk_from_code_v1(code=\"CvipxSKPPn6\")\n", "label": "Python" } ], "required": false } }, "/v1/media/pk/from/url": { "get": { "tags": [ "Post Details" ], "summary": "Attention! Use with (https://ins...ram.com/p/CA2aJYrg6cZ/)", "description": "Get Media pk from URL", "operationId": "v1_media_pk_from_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response V1 Media Pk From Url" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_pk_from_url_v1(url=need_url_here)\n", "label": "Python" } ], "required": false } }, "/v1/story/by/id": { "get": { "tags": [ "Stories" ], "summary": "Story By Id", "description": "Get story object by id", "operationId": "v1_story_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Story" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.story_by_id_v1(id=\"3170083532687367998\")\n", "label": "Python" } ], "required": false } }, "/v1/story/by/url": { "get": { "tags": [ "Stories" ], "summary": "Attention! To work with /s/ links, call /v1/share/by/url first", "description": "Get story object by id", "operationId": "v1_story_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Story" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.story_by_url_v1(url=\"url_to_story\")\n", "label": "Python" } ], "required": false } }, "/v1/story/download": { "get": { "tags": [ "Stories" ], "summary": "Story Download", "description": "Download story media by story id", "operationId": "v1_story_download", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.story_download_v1(id=\"3170083532687367998\")\n", "label": "Python" } ], "required": false } }, "/v1/story/download/by/url": { "get": { "tags": [ "Stories" ], "summary": "Download story file by URL to file", "description": "Download story file by URL to file\n(you can take it from \"/v1/story/by/id\" or \"/v1/story/by/url\")\n\nExample: https://scontent-lga3-1.cdnins...ram.com/v/t66.30100-16/\n 310890533_1622838408176007_5601749632271872566_n.mp4?efg=...", "operationId": "v1_story_download_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.story_download_by_url_v1(url=\"url_to_story\")\n", "label": "Python" } ], "required": false } }, "/v1/story/download/by/story/url": { "get": { "tags": [ "Stories" ], "summary": "Download story file by story URL", "description": "Download story file by story URL\n\nExample: https://ins...ram.com/stories/example/30038568123745341231284", "operationId": "v1_story_download_by_story_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.story_download_by_story_url_v1(url=\"url_to_story\")\n", "label": "Python" } ], "required": false } }, "/v1/location/by/id": { "get": { "tags": [ "Location" ], "summary": "Location By Id", "description": "Get location object by id", "operationId": "v1_location_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.location_by_id_v1(id=\"213131048\")\n", "label": "Python" } ], "required": false } }, "/v1/location/medias/top": { "get": { "tags": [ "Location" ], "summary": "Location Medias Top V1", "description": "Get location top medias", "operationId": "v1_location_medias_top", "parameters": [ { "name": "location_pk", "in": "query", "required": true, "schema": { "type": "integer", "title": "Location Pk" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 21, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 Location Medias Top" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.location_medias_top_v1(location_pk=\"213131048\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/location/medias/recent": { "get": { "tags": [ "Location" ], "summary": "Location Medias Recent V1", "description": "Get location recent medias", "operationId": "v1_location_medias_recent", "parameters": [ { "name": "location_pk", "in": "query", "required": true, "schema": { "type": "integer", "title": "Location Pk" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 63, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 Location Medias Recent" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedias = await cl.location_medias_recent_v1(location_pk=\"213131048\", amount=10)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nmax_id = None\nwhile True:\n items, max_id = cl.location_medias_recent_chunk_v1(\"213131048\", max_id=max_id)\n items_list.extend(items)\n if not max_id:\n break\n ", "label": "Python" } ], "required": false } }, "/v1/location/medias/top/chunk": { "get": { "tags": [ "Location" ], "summary": "Location Medias Top Chunk", "description": "Get location chunk of top medias", "operationId": "v1_location_medias_top_chunk", "parameters": [ { "name": "location_pk", "in": "query", "required": true, "schema": { "type": "integer", "title": "Location Pk" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 Location Medias Top Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedias, max_id = await cl.location_medias_top_chunk_v1(\n location_pk=\"213131048\", max_id=None\n)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nmax_id = None\nwhile True:\n items, max_id = cl.location_medias_top_chunk_v1(\"213131048\", max_id=max_id)\n items_list.extend(items)\n if not max_id:\n break\n ", "label": "Python" } ], "required": false } }, "/v1/location/medias/recent/chunk": { "get": { "tags": [ "Location" ], "summary": "Location Medias Recent Chunk", "description": "Get location chunk of recent medias", "operationId": "v1_location_medias_recent_chunk", "parameters": [ { "name": "location_pk", "in": "query", "required": true, "schema": { "type": "integer", "title": "Location Pk" } }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 Location Medias Recent Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedias, max_id = await cl.location_medias_recent_chunk_v1(\n location_pk=\"213131048\", max_id=None\n)\n", "label": "Python" } ], "required": false } }, "/v1/location/search": { "get": { "tags": [ "Location" ], "summary": "Location Search", "description": "Get locations using lat and long", "operationId": "v1_location_search", "parameters": [ { "name": "lat", "in": "query", "required": true, "schema": { "type": "number", "title": "Lat" } }, { "name": "lng", "in": "query", "required": true, "schema": { "type": "number", "title": "Lng" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" }, "title": "Response V1 Location Search" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.location_search_v1(lat=None, lng=None)\n", "label": "Python" } ], "required": false } }, "/v1/location/guides": { "get": { "tags": [ "Location" ], "summary": "Location Guides V1", "description": "Get location guides", "operationId": "v1_location_guides", "parameters": [ { "name": "location_pk", "in": "query", "required": true, "schema": { "type": "integer", "title": "Location Pk" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Guide" }, "title": "Response V1 Location Guides" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.location_guides_v1(location_pk=\"213131048\")\n", "label": "Python" } ], "required": false } }, "/v1/search/hashtags": { "get": { "tags": [ "Search" ], "summary": "Search Hashtags", "description": "Search hashtags", "operationId": "v1_search_hashtags", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Hashtag" }, "title": "Response V1 Search Hashtags" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.search_hashtags_v1(query=\"love\")\n", "label": "Python" } ], "required": false } }, "/v1/search/users": { "get": { "tags": [ "Search" ], "summary": "It is recommended to use /v2/search/accounts as this endpoint will soon be deprecated.", "description": "Search users", "operationId": "v1_search_users", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserShort" }, "title": "Response V1 Search Users" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.search_users_v1(query=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v1/search/music": { "get": { "tags": [ "Search" ], "summary": "Search Music", "description": "Search music", "operationId": "v1_search_music", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" }, "title": "Response V1 Search Music" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.search_music_v1(query=\"rock\")\n", "label": "Python" } ], "required": false } }, "/v1/fbsearch/places": { "get": { "tags": [ "Search" ], "summary": "Fbsearch Places", "description": "Search locations", "operationId": "v1_fbsearch_places", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "lat", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 40.74, "title": "Lat" } }, { "name": "lng", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": -73.94, "title": "Lng" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" }, "title": "Response V1 Fbsearch Places" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_places_v1(query=\"Berlin\", lat=None, lng=None)\n", "label": "Python" } ], "required": false } }, "/v1/fbsearch/topsearch": { "get": { "tags": [ "Search" ], "summary": "Fbsearch Topsearch", "description": "Topsearch", "operationId": "v1_fbsearch_topsearch", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response V1 Fbsearch Topsearch" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_topsearch_v1(query=\"Berlin\")\n", "label": "Python" } ], "required": false } }, "/v1/fbsearch/topsearch/hashtags": { "get": { "tags": [ "Search" ], "summary": "Web Search Topsearch Hashtags", "description": "Search hashtags via topsearch", "operationId": "v1_fbsearch_topsearch_hashtags", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Hashtag" }, "title": "Response V1 Fbsearch Topsearch Hashtags" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_topsearch_hashtags_v1(query=\"Berlin\")\n", "label": "Python" } ], "required": false } }, "/v1/hashtag/by/name": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag By Name", "description": "Get hashtag object by name", "operationId": "v1_hashtag_by_name", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hashtag" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.hashtag_by_name_v1(name=\"love\")\n", "label": "Python" } ], "required": false } }, "/v1/hashtag/medias/top": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag Medias Top", "description": "Get hashtag medias top", "operationId": "v1_hashtag_medias_top", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 9, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 Hashtag Medias Top" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.hashtag_medias_top_v1(name=\"love\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/hashtag/medias/top/chunk": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag Medias Top Chunk", "description": "Get hashtag chunk of top medias", "operationId": "v1_hashtag_medias_top_chunk", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 Hashtag Medias Top Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems, max_id = await cl.hashtag_medias_top_chunk_v1(name=\"love\", max_id=None)\n", "label": "Python" }, { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nitems_list = []\nmax_id = None\nwhile True:\n items, max_id = cl.hashtag_medias_top_chunk_v1(\"love\", max_id=max_id)\n items_list.extend(items)\n if not max_id:\n break\n ", "label": "Python" } ], "required": false } }, "/v1/hashtag/medias/recent": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag Medias Recent", "description": "Get hashtag medias top", "operationId": "v1_hashtag_medias_recent", "deprecated": true, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 27, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 Hashtag Medias Recent" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.hashtag_medias_recent_v1(name=\"love\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/hashtag/medias/recent/chunk": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag Medias Recent Chunk", "description": "Get hashtag chunk of recent medias", "operationId": "v1_hashtag_medias_recent_chunk", "deprecated": true, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 Hashtag Medias Recent Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.hashtag_medias_recent_chunk_v1(name=\"love\", max_id=None)\n", "label": "Python" } ], "required": false } }, "/v1/hashtag/medias/top/recent/chunk": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag Medias Top Recent Chunk", "description": "Get hashtag chunk of recent medias", "operationId": "v1_hashtag_medias_top_recent_chunk", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 Hashtag Medias Top Recent Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.hashtag_medias_recent_chunk_v1(name=\"love\", max_id=None)\n", "label": "Python" } ], "required": false } }, "/v1/hashtag/medias/clips": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag Medias Clips", "description": "Get hashtag clips (reels)", "operationId": "v1_hashtag_medias_clips", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 27, "title": "Amount" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Media" }, "title": "Response V1 Hashtag Medias Clips" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.hashtag_medias_clips_v1(name=\"love\", amount=10)\n", "label": "Python" } ], "required": false } }, "/v1/hashtag/medias/clips/chunk": { "get": { "tags": [ "Hashtags" ], "summary": "Hashtag Medias Clips Chunk", "description": "Get hashtag chunk of clips (reels)", "operationId": "v1_hashtag_medias_clips_chunk", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. ", "title": "Name" }, "description": "Please make sure to use a clean hashtag without any special symbols. \n\n**Good one**: love, sea, dog, \uacf5\uad6c \n\n**Bad one**: #dog, sea_., tanjung.., #\uacf5\uad6c. " }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [ { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "minItems": 2, "maxItems": 2, "title": "Response V1 Hashtag Medias Clips Chunk" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.hashtag_medias_clips_chunk_v1(name=\"love\", max_id=None)\n", "label": "Python" } ], "required": false } }, "/v1/highlight/by/id": { "get": { "tags": [ "Highlights" ], "summary": "Highlight By Id", "description": "Prefer v2/highlight/by/id", "operationId": "v1_highlight_by_id", "deprecated": true, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Highlight" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.highlight_by_id_v1(id=\"386916469\")\n", "label": "Python" } ], "required": false } }, "/v1/highlight/by/url": { "get": { "tags": [ "Highlights" ], "summary": "Attention! To work with /s/ links, call /v1/share/by/url first", "description": "Get highlight object by id", "operationId": "v1_highlight_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Highlight" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.highlight_by_url_v1(url=\"url_to_highlight\")\n", "label": "Python" } ], "required": false } }, "/v1/share/by/code": { "get": { "tags": [ "Share" ], "summary": "Works for stories and highlights only or use (/v1/media/by/url, /v1/story/by/url)", "description": "Get share object by code (aGlnaGxpZ2h0OjE4MTQ2MjE2Njk4MDIyMTc0 ->\n{\"pk\": 18146216698022176, \"type\": \"highlight\"})", "operationId": "v1_share_by_code", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.share_by_code_v1(code=\"aGlnaGxpZ2h0OjE4MTQ2MjE2Njk4MDIyMTc0\")\n", "label": "Python" } ], "required": false } }, "/v1/share/by/url": { "get": { "tags": [ "Share" ], "summary": "Works for stories and highlights only ig...m.com/s/aGln(link must contain /s/) or use (/v1/media/by/url, /v1/story/by/url)", "description": "Get share object by url (\nhttps://www.ins...ram.com/s/aGlnaGxpZ2h0OjE4MTQ2MjE2Njk4MDIyMTc0 ->\n{\"pk\": 18146216698022176, \"type\": \"highlight\"})", "operationId": "v1_share_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V1 Share By Url" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.share_by_url_v1(\n url=\"https://www.ins...ram.com/s/aGlnaGxpZ2h0OjE4MTQ2MjE2Njk4MDIyMTc0\"\n)\n", "label": "Python" } ], "required": false } }, "/v1/share/reel/by/url": { "get": { "tags": [ "Share" ], "summary": "Works for reel (clips) only", "operationId": "v1_share_reel_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response V1 Share Reel By Url" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.share_reel_by_url_v1(\n url=\"https://www.instagram.com/share/reel/BBX9-xjv1r\"\n)\n", "label": "Python" } ], "required": false } }, "/v2/user/by/id": { "get": { "tags": [ "User Profile" ], "summary": "User By Id", "description": "Get user object by id", "operationId": "v2_user_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 User By Id" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_by_id_v2(id=\"123123\")\n", "label": "Python" } ], "required": false } }, "/v2/user/by/username": { "get": { "tags": [ "Top 5", "User Profile" ], "summary": "Get user object by username (one request required). If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get user object by username", "operationId": "v2_user_by_username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 User By Username" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.user_by_username_v2(username=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v2/userstream/by/username": { "get": { "tags": [ "User Profile" ], "summary": "If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get userstream (info) by username", "operationId": "v2_userstream_by_username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Userstream By Username" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.userstream_by_username_v2(username=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v2/userstream/by/id": { "get": { "tags": [ "User Profile" ], "summary": "If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get userstream (info) by id", "operationId": "v2_userstream_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Userstream By Id" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.userstream_by_id_v2(id=\"123123\")\n", "label": "Python" } ], "required": false } }, "/v2/user/stories": { "get": { "tags": [ "Top 5", "User Profile" ], "summary": "User Stories", "description": "Get user stories", "operationId": "v2_user_stories", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" }, { "name": "safe_int", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Convert all big integers to strings", "title": "Safe Int" }, "description": "Convert all big integers to strings" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 User Stories" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nstories = await cl.user_stories_v2(user_id=\"123123\")\n", "label": "Python" } ], "required": false } }, "/v2/user/stories/by/username": { "get": { "tags": [ "User Profile" ], "summary": "If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get user stories", "operationId": "v2_user_stories_by_username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" }, { "name": "safe_int", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Convert all big integers to strings", "title": "Safe Int" }, "description": "Convert all big integers to strings" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 User Stories By Username" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nstories = await cl.user_stories_by_username_v2(username=\"sun\")\n", "label": "Python" } ], "required": false } }, "/v2/user/medias": { "get": { "tags": [ "Legacy" ], "summary": "Prefer /gql/user/medias - this endpoint will be deprecated", "description": "Get user medias. Results chunk.", "operationId": "v2_user_medias", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Id of user account", "default": "", "title": "User Id" }, "description": "Id of user account" }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" }, { "name": "safe_int", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Convert all big integers to strings", "title": "Safe Int" }, "description": "Convert all big integers to strings" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nmedias, next_page_id = await cl.user_medias_v2(user_id=\"123123\", page_id=None).values()\n", "label": "Python" } ], "required": false } }, "/v2/user/clips": { "get": { "tags": [ "User Profile" ], "summary": "User Clips", "description": "Get user clips.", "operationId": "v2_user_clips", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Id of user account", "default": "", "title": "User Id" }, "description": "Id of user account" }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" }, { "name": "safe_int", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Convert all big integers to strings", "title": "Safe Int" }, "description": "Convert all big integers to strings" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nclips, next_page_id = await cl.user_clips_v2(user_id=\"123123\", page_id=None).values()\n", "label": "Python" } ], "required": false } }, "/v2/user/videos": { "get": { "tags": [ "Legacy" ], "summary": "Prefer using /v2/user/clips or /v2/user/medias instead", "description": "Get part of user videos with cursor (default 50 media per request)", "operationId": "v2_user_videos", "deprecated": true, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Id of user account", "default": "", "title": "User Id" }, "description": "Id of user account" }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nvideos, next_page_id = await cl.user_videos_v2(user_id=\"123123\", page_id=None).values()\n", "label": "Python" } ], "required": false } }, "/v2/user/following": { "get": { "tags": [ "User Profile" ], "summary": "Get a user following (one request required). Prefer /g2/user/following", "description": "Get part (one page) of following users", "operationId": "v2_user_following", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Id of user account", "default": "", "title": "User Id" }, "description": "Id of user account" }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "List of users (following)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nfollowings, next_page_id = await cl.user_following_v2(\n user_id=\"123123\", page_id=None).values()\n", "label": "Python" } ], "required": false } }, "/v2/user/followers": { "get": { "tags": [ "User Profile" ], "summary": "Get a user followers (one request required). Prefer /g2/user/followers", "description": "Get part (one page) of followers users with cursor", "operationId": "v2_user_followers", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Id of user account", "default": "", "title": "User Id" }, "description": "Id of user account" }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "List of users (followers)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nfollowers, next_page_id = await cl.user_followers_v2(\n user_id=\"123123\", page_id=None).values()\n", "label": "Python" } ], "required": false } }, "/v2/user/tag/medias": { "get": { "tags": [ "User Profile" ], "summary": "Get medias where user is tagged", "description": "Get usertag medias", "operationId": "v2_user_tag_medias", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Id of user account", "default": "", "title": "User Id" }, "description": "Id of user account" }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/user/highlights": { "get": { "tags": [ "User Profile" ], "summary": "User Highlights", "description": "Get user highlights", "operationId": "v2_user_highlights", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Amount" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nhighlights = await cl.user_highlights_v2(user_id=\"45915962111\")\n", "label": "Python" } ], "required": false } }, "/v2/user/highlights/by/username": { "get": { "tags": [ "User Profile" ], "summary": "If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.", "description": "Get user highlights by username", "operationId": "v2_user_highlights_by_username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "amount", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Amount" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Skip account privacy check", "title": "Force" }, "description": "Skip account privacy check" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nhighlights = await cl.user_highlights_by_username_v2(username=\"leomessi\")\n", "label": "Python" } ], "required": false } }, "/v2/user/explore/businesses/by/id": { "get": { "tags": [ "User Profile" ], "summary": "Get recommended accounts for category by user id", "description": "Get list of recommended accounts for business category of the user by his id", "operationId": "v2_user_explore_businesses_by_id", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "List of users (Business accounts)", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 User Explore Businesses By Id" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/user/suggested/profiles": { "get": { "tags": [ "User Profile" ], "summary": "Fetch Suggestion Details", "description": "Fetch suggested users details by target_id.\n\nexpand_suggestion=True for more detailed response", "operationId": "v2_user_suggested_profiles", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "expand_suggestion", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Expand Suggestion" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nusers = await cl.user_suggested_profiles_v2(\n user_id=\"1338246453\", expand_suggestion=True)\n", "label": "Python" } ], "required": false } }, "/v2/media/by/id": { "get": { "tags": [ "Legacy" ], "summary": "Prefer using /v2/media/info/by/id as this endpoint will be completely deprecated soon", "description": "Get media object", "operationId": "v2_media_by_id", "deprecated": true, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media By Id" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_id_v2(id=\"2588864825828721736\")\n", "label": "Python" } ], "required": false } }, "/v2/media/info/by/id": { "get": { "tags": [ "Post Details" ], "summary": "Returns 200 for found posts and 404 for unavailable or deleted posts. Other responses are not provided. Doesn't return usertags for video.", "description": "Get media object", "operationId": "v2_media_info_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media Info By Id" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_id_v2(id=\"2588864825828721736\")\n", "label": "Python" } ], "required": false } }, "/v2/media/by/code": { "get": { "tags": [ "Legacy" ], "summary": "Prefer using /v2/media/info/by/code as this endpoint will be completely deprecated soon", "description": "Get media object", "operationId": "v2_media_by_code", "deprecated": true, "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media By Code" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_code_v2(code=\"CvipxSKPPn6\")\n", "label": "Python" } ], "required": false } }, "/v2/media/info/by/code": { "get": { "tags": [ "Post Details" ], "summary": "Returns 200 for found posts and 404 for unavailable or deleted posts. Other responses are not provided. Doesn't return usertags for video.", "description": "Get media object", "operationId": "v2_media_info_by_code", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "title": "Code" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media Info By Code" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_code_v2(code=\"CvipxSKPPn6\")\n", "label": "Python" } ], "required": false } }, "/v2/media/by/url": { "get": { "tags": [ "Legacy" ], "summary": "Prefer using /v2/media/info/by/url as this endpoint will be completely deprecated soon", "description": "Get media object", "operationId": "v2_media_by_url", "deprecated": true, "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media By Url" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_url_v2(url=\"https://ins...ram.com/p/CA2aJYrg6cZ/\")\n", "label": "Python" } ], "required": false } }, "/v2/media/info/by/url": { "get": { "tags": [ "Post Details" ], "summary": "Returns 200 for found posts and 404 for unavailable or deleted posts. Other responses are not provided. Doesn't return usertags for video. Attention! Use with https://ins...ram.com/p/CA2aJYrg6cZ/", "description": "Get media object", "operationId": "v2_media_info_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media Info By Url" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_by_url_v2(url=\"https://ins...ram.com/p/CA2aJYrg6cZ/\")\n", "label": "Python" } ], "required": false } }, "/v2/media/comments": { "get": { "tags": [ "Top 5", "Post Details", "Comments" ], "summary": "Get media comments (one request return 15 comments)", "description": "Get comments on a media", "operationId": "v2_media_comments", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "can_support_threading", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Can Support Threading" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Page Id" } } ], "responses": { "200": { "description": "List of comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/media/likers": { "get": { "tags": [ "Post Details" ], "summary": "Media Likers", "description": "Get user's likers", "operationId": "v2_media_likers", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media Likers" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_likers_v2(id=\"2588864825828721736\")\n", "label": "Python" } ], "required": false } }, "/v2/media/template": { "get": { "tags": [ "Post Details" ], "summary": "Media Template", "description": "Get media template", "operationId": "v2_media_template", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Media Template" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.media_template_v2(id=\"2934927996541863400\")\n", "label": "Python" } ], "required": false } }, "/v2/media/comment/offensive": { "get": { "tags": [ "Post Details", "Comments" ], "summary": "Media Check Offensive Comment", "description": "Whether to receive an offensive comment", "operationId": "v2_media_comment_offensive", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "comment", "in": "query", "required": true, "schema": { "type": "string", "title": "Comment" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\noffensive_comment = await cl.media_offensive_comment_v2(\n media_id=\"3162273595027945978\", comment=\"offensiveword\"\n)\n", "label": "Python" } ], "required": false } }, "/v2/media/comments/replies": { "get": { "tags": [ "Post Details", "Comments" ], "summary": "Media Comments Replies", "description": "Get media comment replies with pagination by min_id", "operationId": "v2_media_comments_replies", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Comment Id" } }, { "name": "min_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Min Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nreplies = await cl.media_comments_replies_v2(\n media_id=\"3770903101839112303_185336999\", comment_id=\"18120112390529134\"\n)\n", "label": "Python" } ], "required": false } }, "/v2/story/by/id": { "get": { "tags": [ "Stories" ], "summary": "Story By Id", "description": "Get story object by id", "operationId": "v2_story_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Story By Id" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/story/by/url": { "get": { "tags": [ "Stories" ], "summary": "Attention! To work with /s/ links, call /v1/share/by/url first", "description": "Get story object by id", "operationId": "v2_story_by_url", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Story By Url" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/track/by/canonical/id": { "get": { "tags": [ "Audio" ], "summary": "Track By Canonical Id", "description": "Get music track object by canonical_id", "operationId": "v2_track_by_canonical_id", "parameters": [ { "name": "canonical_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Canonical Id" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.track_by_canonical_id_v2(canonical_id=\"1592175977822689\")\n", "label": "Python" } ], "required": false } }, "/v2/track/by/id": { "get": { "tags": [ "Audio" ], "summary": "Track By Id", "description": "Get music track object by id", "operationId": "v2_track_by_id", "parameters": [ { "name": "track_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Track Id" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.track_by_id_v2(track_id=\"1592175977822689\")\n", "label": "Python" } ], "required": false } }, "/v2/track/stream/by/id": { "get": { "tags": [ "Audio" ], "summary": "Track Stream By Id", "description": "Get music track object by id", "operationId": "v2_track_stream_by_id", "parameters": [ { "name": "track_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Track Id" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.track_by_id_v2(track_id=\"1592175977822689\")\n", "label": "Python" } ], "required": false } }, "/v2/hashtag/by/name": { "get": { "tags": [ "Hashtags", "/v2/hashtag" ], "summary": "Hashtag By Name", "description": "Get hashtag object by name", "operationId": "v2_hashtag_by_name", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Hashtag By Name" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/hashtag/medias/top": { "get": { "tags": [ "Hashtags", "/v2/hashtag" ], "summary": "Hashtag Medias Top Chunk", "description": "Get hashtag chunk of top medias", "operationId": "v2_hashtag_medias_top", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/hashtag/medias/recent": { "get": { "tags": [ "Hashtags", "/v2/hashtag" ], "summary": "Hashtag Medias Recent Chunk", "description": "Get hashtag chunk of recent medias", "operationId": "v2_hashtag_medias_recent", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/hashtag/medias/clips": { "get": { "tags": [ "Hashtags", "/v2/hashtag" ], "summary": "Switch to /v2/fbsearch/reels \u2014 this endpoint will be deprecated soon. It currently returns all media types, not just reels.", "description": "Get hashtag chunk of clips (reels)", "operationId": "v2_hashtag_medias_clips", "deprecated": true, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Use value of field `next_page_id` from response for getting next page", "default": "", "title": "Page Id" }, "description": "Use value of field `next_page_id` from response for getting next page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/highlight/by/id": { "get": { "tags": [ "Highlights" ], "summary": "Highlight By Id", "description": "Get highlight object by id", "operationId": "v2_highlight_by_id", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PageResponse" }, { "type": "object", "additionalProperties": true } ], "title": "Response V2 Highlight By Id" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.highlight_by_id_v2(id=\"386916469\")\n", "label": "Python" } ], "required": false } }, "/v2/search/hashtags": { "get": { "tags": [ "Search" ], "summary": "Search Hashtags", "description": "Search hashtags", "operationId": "v2_search_hashtags", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "title": "Page Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Search Hashtags" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.search_hashtags_v2(query=\"love\")\n", "label": "Python" } ], "required": false } }, "/v2/search/accounts": { "get": { "tags": [ "Search" ], "summary": "Switch to /v2/fbsearch/accounts \u2014 this endpoint will be deprecated soon. The current route doesn't support paging.", "description": "Search accounts", "operationId": "v2_search_accounts", "deprecated": true, "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "title": "Page Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Search Accounts" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_accounts_v2(query=\"rock\", page_token=None)\n", "label": "Python" } ], "required": false } }, "/v2/search/music": { "get": { "tags": [ "Search" ], "summary": "Search Music", "description": "Search music", "operationId": "v2_search_music", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "next_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Next Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Search Music" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.search_music_v2(query=\"rock\")\n", "label": "Python" } ], "required": false } }, "/v2/search/places": { "get": { "tags": [ "Search" ], "summary": "Prefer using /v3/fbsearch/places as this endpoint will be deprecated soon", "description": "Search places", "operationId": "v2_search_places", "deprecated": true, "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Search Places" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_places_v2(query=\"rock\")\n", "label": "Python" } ], "required": false } }, "/v2/search/topsearch": { "get": { "tags": [ "Search" ], "summary": "Prefer using /v3/fbsearch/topsearch as this endpoint will be deprecated soon", "description": "Search top content by keyword", "operationId": "v2_search_topsearch", "deprecated": true, "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "next_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Next Max Id" } }, { "name": "rank_token", "in": "query", "required": false, "schema": { "type": "string", "title": "Rank Token" } }, { "name": "reels_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Reels Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Search Topsearch" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_places_top_v2(query=\"rock\")\n", "label": "Python" } ], "required": false } }, "/v2/search/reels": { "get": { "tags": [ "Search" ], "summary": "Prefer using /v3/fbsearch/reels as this endpoint will be deprecated soon", "description": "Search top content by keyword", "operationId": "v2_search_reels", "deprecated": true, "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "reels_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Reels Max Id" } }, { "name": "rank_token", "in": "query", "required": false, "schema": { "type": "string", "title": "Rank Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Search Reels" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_reels_top_v2(query=\"rock\", reels_max_id=None)\n", "label": "Python" } ], "required": false } }, "/v2/fbsearch/accounts": { "get": { "tags": [ "Search" ], "summary": "Fbsearch Accounts", "description": "Search accounts", "operationId": "v2_fbsearch_accounts", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "title": "Page Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Fbsearch Accounts" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_accounts_v2(query=\"rock\", page_token=None)\n", "label": "Python" } ], "required": false } }, "/v2/fbsearch/places": { "get": { "tags": [ "Search" ], "summary": "Fbsearch Places", "description": "Search places", "operationId": "v2_fbsearch_places", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Fbsearch Places" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_places_v2(query=\"rock\")\n", "label": "Python" } ], "required": false } }, "/v2/fbsearch/topsearch": { "get": { "tags": [ "Top 5", "Search" ], "summary": "Fbsearch Top", "description": "Search top content by keyword", "operationId": "v2_fbsearch_topsearch", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "next_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Next Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Fbsearch Topsearch" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_top_v2(query=\"rock\", next_max_id=None)\n", "label": "Python" } ], "required": false } }, "/v2/fbsearch/reels": { "get": { "tags": [ "Search" ], "summary": "Fbsearch Reels", "description": "Search top content by keyword", "operationId": "v2_fbsearch_reels", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "reels_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Reels Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V2 Fbsearch Reels" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-codeSamples": [ { "lang": "Python", "source": "from hikerapi import Client\n\ncl = Client()\nres = await cl.fbsearch_reels_top_v2(query=\"rock\", reels_max_id=None)\n", "label": "Python" } ], "required": false } }, "/v3/fbsearch/accounts": { "get": { "tags": [ "Search" ], "summary": "Fbsearch Accounts", "description": "Search accounts", "operationId": "v3_fbsearch_accounts", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "title": "Page Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V3 Fbsearch Accounts" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v3/fbsearch/places": { "get": { "tags": [ "Search" ], "summary": "Fbsearch Places", "description": "Search places", "operationId": "v3_fbsearch_places", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V3 Fbsearch Places" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v3/fbsearch/topsearch": { "get": { "tags": [ "Search" ], "summary": "Prefer using /gql/topsearch as this endpoint has pagination issues with duplicate results", "description": "Search top content by keyword", "operationId": "v3_fbsearch_topsearch", "deprecated": true, "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "next_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Next Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V3 Fbsearch Topsearch" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v3/fbsearch/reels": { "get": { "tags": [ "Search" ], "summary": "Deprecated due to pagination issues with duplicate results", "description": "Search reels by keyword", "operationId": "v3_fbsearch_reels", "deprecated": true, "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } }, { "name": "reels_max_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Reels Max Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response V3 Fbsearch Reels" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/g2/user/followers": { "get": { "tags": [ "User Profile" ], "summary": "Get a user followers (one request required)", "description": "Get part (one page) of followers users with cursor", "operationId": "g2_user_followers", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Page Id" } } ], "responses": { "200": { "description": "List of followers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/g2/user/following": { "get": { "tags": [ "User Profile" ], "summary": "Get a user following (one request required)", "description": "Get part (one page) of following users with cursor", "operationId": "g2_user_following", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "page_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Page Id" } } ], "responses": { "200": { "description": "List of following users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "About": { "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "default": "" }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified", "default": false }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "default": "" }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date", "default": "" }, "former_usernames": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Former Usernames", "default": "" } }, "type": "object", "title": "About" }, "Comment": { "properties": { "pk": { "type": "string", "title": "Pk" }, "text": { "type": "string", "title": "Text" }, "user": { "$ref": "#/components/schemas/UserShort" }, "created_at_utc": { "type": "string", "format": "date-time", "title": "Created At Utc" }, "content_type": { "type": "string", "title": "Content Type" }, "status": { "type": "string", "title": "Status" }, "has_liked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Liked" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count" } }, "type": "object", "required": [ "pk", "text", "user", "created_at_utc", "content_type", "status" ], "title": "Comment" }, "Guide": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "type": "string", "title": "Description" }, "cover_media": { "$ref": "#/components/schemas/Media" }, "feedback_item": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Feedback Item" } }, "type": "object", "required": [ "description", "cover_media" ], "title": "Guide" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Hashtag": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "type": "string", "title": "Name" }, "media_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Count" }, "allow_following": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Following" }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Url" } }, "type": "object", "required": [ "name" ], "title": "Hashtag" }, "Highlight": { "properties": { "pk": { "type": "string", "title": "Pk" }, "id": { "type": "string", "title": "Id" }, "latest_reel_media": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latest Reel Media" }, "cover_media": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Cover Media" }, "user": { "$ref": "#/components/schemas/UserShort" }, "title": { "type": "string", "title": "Title" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "is_pinned_highlight": { "type": "boolean", "title": "Is Pinned Highlight" }, "media_count": { "type": "integer", "title": "Media Count" }, "media_ids": { "items": { "type": "integer" }, "type": "array", "title": "Media Ids", "default": [] }, "items": { "items": { "$ref": "#/components/schemas/Story" }, "type": "array", "title": "Items", "default": [] } }, "type": "object", "required": [ "pk", "id", "user", "title", "created_at", "is_pinned_highlight", "media_count" ], "title": "Highlight" }, "Location": { "properties": { "pk": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pk" }, "name": { "type": "string", "title": "Name" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone", "default": "" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "default": "" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "default": "" }, "hours": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Hours", "default": {} }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "default": "" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "default": "" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip", "default": "" }, "lng": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lng" }, "lat": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lat" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "external_id_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id Source" } }, "type": "object", "required": [ "name" ], "title": "Location" }, "Media": { "properties": { "pk": { "type": "string", "title": "Pk" }, "id": { "type": "string", "title": "Id" }, "code": { "type": "string", "title": "Code" }, "taken_at": { "type": "string", "format": "date-time", "title": "Taken At" }, "taken_at_ts": { "type": "integer", "title": "Taken At Ts" }, "media_type": { "type": "integer", "title": "Media Type" }, "product_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Type", "default": "" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/Location" }, { "type": "null" } ] }, "user": { "$ref": "#/components/schemas/UserShort" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "default": 0 }, "comments_disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Comments Disabled", "default": false }, "like_count": { "type": "integer", "title": "Like Count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count" }, "has_liked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Liked" }, "caption_text": { "type": "string", "title": "Caption Text" }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accessibility Caption" }, "usertags": { "items": { "$ref": "#/components/schemas/Usertag" }, "type": "array", "title": "Usertags" }, "sponsor_tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UserShort" }, "type": "array" }, { "type": "null" } ], "title": "Sponsor Tags", "default": [] }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url" }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "default": 0 }, "video_duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video Duration", "default": 0.0 }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "default": "" }, "resources": { "items": { "$ref": "#/components/schemas/Resource" }, "type": "array", "title": "Resources", "default": [] }, "image_versions": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Image Versions", "default": [] }, "video_versions": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Video Versions", "default": [] }, "clips_metadata": { "additionalProperties": true, "type": "object", "title": "Clips Metadata", "default": {} }, "video_dash_manifest": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Dash Manifest", "default": "" }, "like_and_view_counts_disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Like And View Counts Disabled" }, "coauthor_producers": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Coauthor Producers", "default": [] }, "is_paid_partnership": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Paid Partnership" } }, "type": "object", "required": [ "pk", "id", "code", "taken_at", "taken_at_ts", "media_type", "user", "like_count", "caption_text", "usertags" ], "title": "Media" }, "MediaOembed": { "properties": { "title": { "type": "string", "title": "Title" }, "author_name": { "type": "string", "title": "Author Name" }, "author_url": { "type": "string", "title": "Author Url" }, "author_id": { "type": "string", "title": "Author Id" }, "media_id": { "type": "string", "title": "Media Id" }, "provider_name": { "type": "string", "title": "Provider Name" }, "provider_url": { "type": "string", "title": "Provider Url" }, "type": { "type": "string", "title": "Type" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width" }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height" }, "html": { "type": "string", "title": "Html" }, "thumbnail_url": { "type": "string", "title": "Thumbnail Url" }, "thumbnail_width": { "type": "integer", "title": "Thumbnail Width" }, "thumbnail_height": { "type": "integer", "title": "Thumbnail Height" }, "can_view": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Can View" } }, "type": "object", "required": [ "title", "author_name", "author_url", "author_id", "media_id", "provider_name", "provider_url", "type", "html", "thumbnail_url", "thumbnail_width", "thumbnail_height" ], "title": "MediaOembed" }, "PageResponse": { "properties": { "response": { "additionalProperties": true, "type": "object", "title": "Response", "description": "Dict with full response.", "examples": [ { "...": "...", "items": [ { "...": "..." } ] } ] }, "next_page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page Id", "description": "Next Page ID. Use it value for next request", "examples": [ "QEFerVFGGdsfd_1234567890" ] } }, "type": "object", "required": [ "response", "next_page_id" ], "title": "PageResponse" }, "ReelOwner": { "properties": { "id": { "type": "integer", "title": "Id" }, "profile_pic_url": { "type": "string", "title": "Profile Pic Url" }, "username": { "type": "string", "title": "Username" } }, "type": "object", "required": [ "id", "profile_pic_url", "username" ], "title": "ReelOwner" }, "Resource": { "properties": { "pk": { "type": "string", "title": "Pk" }, "id": { "type": "string", "title": "Id" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url" }, "thumbnail_url": { "type": "string", "title": "Thumbnail Url" }, "media_type": { "type": "integer", "title": "Media Type" }, "product_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Type" }, "image_versions": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Image Versions", "default": [] }, "video_versions": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Video Versions", "default": [] }, "preview": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Preview" }, "carousel_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Carousel Parent Id" }, "commerciality_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commerciality Status" }, "taken_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Taken At" } }, "type": "object", "required": [ "pk", "id", "thumbnail_url", "media_type" ], "title": "Resource" }, "Share": { "properties": { "pk": { "type": "string", "title": "Pk" }, "type": { "type": "string", "title": "Type" } }, "type": "object", "required": [ "pk", "type" ], "title": "Share" }, "Story": { "properties": { "pk": { "type": "string", "title": "Pk" }, "id": { "type": "string", "title": "Id" }, "code": { "type": "string", "title": "Code" }, "taken_at": { "type": "string", "format": "date-time", "title": "Taken At" }, "media_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Type" }, "product_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Type", "default": "" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "user": { "$ref": "#/components/schemas/UserShort" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url" }, "video_duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Video Duration", "default": 0.0 }, "sponsor_tags": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UserShort" }, "type": "array" }, { "type": "null" } ], "title": "Sponsor Tags", "default": [] }, "mentions": { "items": { "$ref": "#/components/schemas/StoryMention" }, "type": "array", "title": "Mentions" }, "links": { "items": { "$ref": "#/components/schemas/StoryLink" }, "type": "array", "title": "Links" }, "hashtags": { "items": { "$ref": "#/components/schemas/StoryHashtag" }, "type": "array", "title": "Hashtags" }, "locations": { "items": { "$ref": "#/components/schemas/StoryLocation" }, "type": "array", "title": "Locations" }, "stickers": { "items": { "$ref": "#/components/schemas/StorySticker" }, "type": "array", "title": "Stickers" }, "medias": { "items": { "$ref": "#/components/schemas/StoryMedia" }, "type": "array", "title": "Medias", "default": [] } }, "type": "object", "required": [ "pk", "id", "code", "taken_at", "user", "mentions", "links", "hashtags", "locations", "stickers" ], "title": "Story" }, "StoryHashtag": { "properties": { "hashtag": { "$ref": "#/components/schemas/Hashtag" }, "x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "X" }, "y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Y" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Width" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Height" } }, "type": "object", "required": [ "hashtag" ], "title": "StoryHashtag" }, "StoryLink": { "properties": { "webUri": { "type": "string", "title": "Weburi" }, "x": { "type": "number", "title": "X", "default": 0.5126011 }, "y": { "type": "number", "title": "Y", "default": 0.5168225 }, "z": { "type": "number", "title": "Z", "default": 0.0 }, "width": { "type": "number", "title": "Width", "default": 0.50998676 }, "height": { "type": "number", "title": "Height", "default": 0.25875 }, "rotation": { "type": "number", "title": "Rotation", "default": 0.0 } }, "type": "object", "required": [ "webUri" ], "title": "StoryLink" }, "StoryLocation": { "properties": { "location": { "$ref": "#/components/schemas/Location" }, "x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "X" }, "y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Y" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Width" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Height" } }, "type": "object", "required": [ "location" ], "title": "StoryLocation" }, "StoryMedia": { "properties": { "x": { "type": "number", "title": "X", "default": 0.5 }, "y": { "type": "number", "title": "Y", "default": 0.4997396 }, "z": { "type": "number", "title": "Z", "default": 0 }, "width": { "type": "number", "title": "Width", "default": 0.8 }, "height": { "type": "number", "title": "Height", "default": 0.60572916 }, "rotation": { "type": "number", "title": "Rotation", "default": 0.0 }, "is_pinned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Pinned" }, "is_hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Hidden" }, "is_sticker": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Sticker" }, "is_fb_sticker": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Fb Sticker" }, "media_pk": { "type": "string", "title": "Media Pk" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "product_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Type" }, "media_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Code" } }, "type": "object", "required": [ "media_pk" ], "title": "StoryMedia" }, "StoryMention": { "properties": { "user": { "$ref": "#/components/schemas/UserShort" }, "x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "X" }, "y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Y" }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Width" }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Height" } }, "type": "object", "required": [ "user" ], "title": "StoryMention" }, "StorySticker": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "default": "gif" }, "x": { "type": "number", "title": "X" }, "y": { "type": "number", "title": "Y" }, "z": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Z", "default": 1000005 }, "width": { "type": "number", "title": "Width" }, "height": { "type": "number", "title": "Height" }, "rotation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rotation", "default": 0.0 }, "story_link": { "anyOf": [ { "$ref": "#/components/schemas/StoryStickerLink" }, { "type": "null" } ] }, "extra": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extra", "default": {} } }, "type": "object", "required": [ "x", "y", "width", "height" ], "title": "StorySticker" }, "StoryStickerLink": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "link_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link Title" }, "link_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link Type" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Url" } }, "type": "object", "title": "StoryStickerLink" }, "Track": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "subtitle": { "type": "string", "title": "Subtitle" }, "display_artist": { "type": "string", "title": "Display Artist" }, "audio_cluster_id": { "type": "string", "title": "Audio Cluster Id" }, "artist_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Artist Id" }, "cover_artwork_uri": { "type": "string", "title": "Cover Artwork Uri" }, "cover_artwork_thumbnail_uri": { "type": "string", "title": "Cover Artwork Thumbnail Uri" }, "progressive_download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Progressive Download Url" }, "fast_start_progressive_download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fast Start Progressive Download Url" }, "reactive_audio_download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reactive Audio Download Url" }, "highlight_start_times_in_ms": { "items": { "type": "integer" }, "type": "array", "title": "Highlight Start Times In Ms" }, "is_explicit": { "type": "boolean", "title": "Is Explicit" }, "dash_manifest": { "type": "string", "title": "Dash Manifest" }, "has_lyrics": { "type": "boolean", "title": "Has Lyrics" }, "audio_asset_id": { "type": "string", "title": "Audio Asset Id" }, "duration_in_ms": { "type": "integer", "title": "Duration In Ms" }, "dark_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dark Message" }, "allows_saving": { "type": "boolean", "title": "Allows Saving" }, "territory_validity_periods": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Territory Validity Periods" } }, "type": "object", "required": [ "id", "title", "subtitle", "display_artist", "audio_cluster_id", "cover_artwork_uri", "cover_artwork_thumbnail_uri", "highlight_start_times_in_ms", "is_explicit", "dash_manifest", "has_lyrics", "audio_asset_id", "duration_in_ms", "allows_saving" ], "title": "Track" }, "User": { "properties": { "pk": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Pk" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private" }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Url" }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Url Hd" }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified" }, "media_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Count" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count" }, "following_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Following Count" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Biography", "default": "" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Url" }, "account_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Account Type" }, "is_business": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Business" }, "public_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Email" }, "contact_phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contact Phone Number" }, "public_phone_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Phone Country Code" }, "public_phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Phone Number" }, "business_contact_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Contact Method" }, "business_category_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Category Name" }, "category_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category Name" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "address_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Street" }, "city_id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "City Id" }, "city_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City Name" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" }, "instagram_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instagram Location Id" }, "interop_messaging_user_fbid": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Interop Messaging User Fbid" } }, "type": "object", "required": [ "pk" ], "title": "User" }, "UserReel": { "properties": { "id": { "type": "integer", "title": "Id" }, "expiring_at": { "type": "integer", "title": "Expiring At" }, "has_pride_media": { "type": "boolean", "title": "Has Pride Media" }, "latest_reel_media": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Latest Reel Media" }, "seen": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seen" }, "owner": { "$ref": "#/components/schemas/ReelOwner" } }, "type": "object", "required": [ "id", "expiring_at", "has_pride_media", "owner" ], "title": "UserReel" }, "UserShort": { "properties": { "pk": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Pk" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "default": "" }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Url" }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Url Hd" }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private" }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified" } }, "type": "object", "required": [ "pk" ], "title": "UserShort" }, "UserShortWithReel": { "properties": { "pk": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Pk" }, "id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Id" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "default": "" }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Url" }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Url Hd" }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private" }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified" }, "reel": { "$ref": "#/components/schemas/UserReel" } }, "type": "object", "required": [ "pk", "reel" ], "title": "UserShortWithReel" }, "Usertag": { "properties": { "user": { "$ref": "#/components/schemas/UserShort" }, "x": { "type": "number", "title": "X" }, "y": { "type": "number", "title": "Y" } }, "type": "object", "required": [ "user", "x", "y" ], "title": "Usertag" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } } }, "tags": [ { "name": "Top 5", "description": "Most popular endpoints - start here" }, { "name": "User Profile", "description": "Get user info, followers, following, posts & reels, stories", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.user_by_id_v1" } }, { "name": "Post Details", "description": "Get media/post info by ID, code or URL. Likers, insights", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.media_by_id_v1" } }, { "name": "Comments", "description": "Get comments on posts, comment likers, replies", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.media_comments_v1" } }, { "name": "Search", "description": "Search users, hashtags, locations, music", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.search_hashtags_v1" } }, { "name": "Hashtags", "description": "Get hashtag info and medias (top, recent, clips)", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.hashtag_by_name_v1" } }, { "name": "Audio", "description": "Music and audio related endpoints", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.track_by_canonical_id_v2" } }, { "name": "Location", "description": "Location info and medias", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.location_by_id_v1" } }, { "name": "Stories", "description": "Stories by ID/URL, story download", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.story_by_id_v1" } }, { "name": "Highlights", "description": "Highlights by ID/URL", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html#hikerapi.AsyncClient.highlight_by_id_v1" } }, { "name": "Share", "description": "Resolve share links (/s/, /reel/ URLs)", "externalDocs": { "description": "Documentation", "url": "https://hiker-doc.readthedocs.io/en/latest/python.html" } }, { "name": "Legacy", "description": "Deprecated - use recommended alternatives" } ], "externalDocs": { "description": "Get the access_key", "url": "https://hikerapi.com/tokens" }, "servers": [ { "url": "https://api.hikerapi.com", "description": "via Cloudflare" }, { "url": "https://api.instagrapi.com", "description": "without Cloudflare" } ] }