> ## Documentation Index
> Fetch the complete documentation index at: https://hikerapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HikerAPI Features and API Endpoints

> Catalog of non-deprecated API operations, generated from the OpenAPI specification at build time.

Canonical: https://hikerapi.com/features

Authenticate with the `x-access-key` header. See the [authentication guide](https://hikerapi.com/auth.md), [API reference](https://api.hikerapi.com/docs) and [OpenAPI specification](https://api.hikerapi.com/openapi.json) for parameters, response schemas and endpoint-specific billing.

## Top 5

- `GET /v2/fbsearch/topsearch` — Fbsearch Top
- `GET /v2/media/comments` — Get media comments (one request return 15 comments)
- `GET /v2/user/by/username` — 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.
- `GET /gql/user/medias` — Returns the user medias
- `GET /v2/user/stories` — User Stories

## User Profile

- `GET /v2/user/by/id` — User By Id
- `GET /v1/user/by/username` — 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.
- `GET /v1/user/by/id` — User By Id
- `GET /v1/user/about` — We recommend switching to /gql/user/about
- `GET /v2/user/following` — Get a user following (one request required). Prefer /g2/user/following
- `GET /gql/user/following/chunk` — Get a user following (one request required)
- `GET /gql/user/followers/chunk` — Get a user followers (one request required)
- `GET /v2/user/clips` — User Clips
- `GET /gql/user/reposts` — Get user's reposted content
- `GET /v2/user/stories/by/username` — If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.
- `GET /v2/user/tag/medias` — Get medias where user is tagged
- `GET /v1/user/stories` — User Stories
- `GET /a2/user` — User
- `GET /v2/user/highlights` — User Highlights
- `GET /v2/user/highlights/by/username` — If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.
- `GET /v1/user/clips/chunk` — User Clips Chunk
- `GET /gql/user/clips` — Returns the user's short video posts (reels).
- `GET /v1/user/by/url` — Get user object by URL (one request required)
- `GET /v2/userstream/by/username` — If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.
- `GET /v2/userstream/by/id` — If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.
- `GET /v1/user/search/following` — Search Following
- `GET /v1/user/search/followers` — Search Followers
- `GET /v1/user/following/chunk` — Get a user following (one request required)
- `GET /v1/user/followers/chunk` — Get a user followers (one request required)
- `GET /g2/user/followers` — Get a user followers (one request required)
- `GET /g2/user/following` — Get a user following (one request required)
- `GET /v2/user/suggested/profiles` — Fetch Suggestion Details
- `GET /v2/user/explore/businesses/by/id` — Get recommended accounts for category by user id
- `GET /gql/user/about` — User About
- `GET /g2/user/clips` — Get a user's reels through web GraphQL
- `GET /g2/user/followers/search` — Search a user's followers by name (one request required)
- `GET /g2/user/following/search` — Search a user's following by name (one request required)
- `GET /g2/user/medias` — Get a user profile media (one page)
- `GET /g2/user/posts` — Get a user's posts through web GraphQL
- `GET /g2/user/reposts` — Get a user's reposts through web GraphQL
- `GET /g2/user/tagged` — Get media tagging a user through web GraphQL
- `GET /gql/user/highlights` — Get a user's web highlights GraphQL response
- `GET /gql/user/stories` — Get a user's web stories GraphQL response
- `GET /gql/user/web_profile_info` — Get user profile info GraphQL
- `GET /v1/user/highlights` — User Highlights
- `GET /v1/user/highlights/by/username` — If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.
- `GET /v1/user/medias/pinned` — Get pinned medias
- `GET /v1/user/stories/by/username` — If speed is crucial, it's more efficient to use the by/id endpoint for quicker responses.
- `GET /v1/user/tag/medias/chunk` — Usertag Medias Chunk

## Post Details

- `GET /v2/media/info/by/code` — Returns 200 for found posts and 404 for unavailable or deleted posts. Other responses are not provided. Doesn't return usertags for video. Note: promoted/ad posts (product\_type=ad) may return 404 — use /v1/media/by/code instead for those.
- `GET /v2/media/comments/replies` — Media Comments Replies
- `GET /v2/media/likers` — Media Likers
- `GET /v1/media/by/url` — Attention! Use with (https://ins...ram.com/p/CA2aJYrg6cZ/)
- `GET /v1/media/comments/chunk` — Get media comments (one request return 15 comments)
- `GET /v2/media/info/by/url` — Returns 200 for found posts, 404 for unavailable or deleted posts and 400 for malformed URLs (story/share/audio links, numeric IDs, template placeholders) with a hint to the right endpoint. Doesn't return usertags for video. Attention! Use with https://ins...ram.com/p/CA2aJYrg6cZ/. Note: promoted/ad posts (product\_type=ad) may return 404 — use /v1/media/by/url instead for those.
- `GET /v1/media/by/code` — Media By Code
- `GET /v2/media/info/by/id` — Returns 200 for found posts and 404 for unavailable or deleted posts. Other responses are not provided. Doesn't return usertags for video. Note: promoted/ad posts (product\_type=ad) may return 404 — use /v1/media/by/id instead for those.
- `GET /v1/media/likers` — Media Likers
- `GET /v1/media/insight` — Insights Media
- `GET /v2/media/comment/offensive` — Media Check Offensive Comment
- `GET /v1/media/oembed` — Media Oembed
- `GET /gql/media/usertags` — Returns users tagged in the video. You can pass up to 10 media ids
- `GET /gql/media/likers` — Media Likers
- `GET /v2/media/template` — Media Template
- `GET /gql/media/clips_metadata` — Returns clips metadata for the given medias: original sound info (audio\_asset\_id, duration\_in\_ms, ig\_artist, consumption\_info), music\_info and content appreciation (gifts) state. Batch endpoint — you can pass up to 10 media ids
- `GET /v1/media/by/id` — Media By Id
- `GET /v1/media/code/from/pk` — Media Code From Pk
- `GET /v1/media/pk/from/code` — Media Pk From Code
- `GET /v1/media/pk/from/url` — Attention! Use with (https://ins...ram.com/p/CA2aJYrg6cZ/)
- `GET /v1/media/user` — Media User
- `GET /v2/media/comments/infos` — Returns comment metadata for several medias in one request: comment\_count, has\_more\_comments, comment\_threading\_enabled, comment\_likes\_enabled and preview\_comments. Use this instead of /v2/media/comments when you only need counts. Batch endpoint — you can pass up to 10 media ids
- `GET /v3/media/likers` — Media Likers

## Comments

- `GET /gql/comment/likers/chunk` — Comment Likers Chunk
- `GET /g2/media/comments` — Get raw web post comments

## Search

- `GET /v3/fbsearch/accounts` — Fbsearch Accounts
- `GET /v1/search/hashtags` — Search Hashtags
- `GET /v1/search/users` — It is recommended to use /v2/search/accounts as this endpoint will soon be deprecated.
- `GET /v2/fbsearch/reels` — Fbsearch Reels
- `GET /v2/fbsearch/accounts` — Fbsearch Accounts
- `GET /v2/search/music` — Search Music
- `GET /v2/search/hashtags` — Search Hashtags
- `GET /gql/topsearch` — Topsearch
- `GET /v3/fbsearch/places` — Fbsearch Places
- `GET /v1/fbsearch/places` — Fbsearch Places
- `GET /v1/search/music` — Search Music
- `GET /v1/fbsearch/topsearch/hashtags` — Web Search Topsearch Hashtags
- `GET /v2/fbsearch/places` — Fbsearch Places

## Hashtags

- `GET /v2/hashtag/medias/top` — Hashtag Medias Top Chunk
- `GET /v2/hashtag/medias/recent` — Hashtag Medias Recent Chunk
- `GET /v1/hashtag/medias/top/chunk` — Hashtag Medias Top Chunk
- `GET /v1/hashtag/by/name` — Hashtag By Name
- `GET /v2/hashtag/by/name` — Hashtag By Name
- `GET /v1/hashtag/medias/clips/chunk` — Hashtag Medias Clips Chunk

## Audio

- `GET /v2/track/by/id` — Track By Id
- `GET /v2/track/stream/by/id` — Track Stream By Id
- `GET /v2/track/by/canonical/id` — Track By Canonical Id

## Location

- `GET /g2/location/by/id` — Get location details by id (name, lat/lng, category, description)
- `GET /g2/location/web/by/id` — Get raw location details through web GraphQL
- `GET /v1/location/medias/recent/chunk` — Location Medias Recent Chunk
- `GET /v1/location/medias/recent` — Location Medias Recent V1
- `GET /v1/location/search` — Location Search
- `GET /v1/location/medias/top` — Location Medias Top V1
- `GET /v1/location/medias/top/chunk` — Location Medias Top Chunk
- `GET /v1/location/by/id` — Get location object by id (legacy: lat/lng are no longer returned — prefer /g2/location/by/id)
- `GET /v1/location/guides` — Location Guides V1

## Stories

- `GET /v2/story/by/url` — Attention! To work with /s/ links, call /v1/share/by/url first
- `GET /v1/story/by/url` — Attention! To work with /s/ links, call /v1/share/by/url first
- `GET /v1/story/by/id` — Story By Id
- `GET /v2/story/by/id` — Story By Id
- `GET /v1/story/download` — Story Download
- `GET /v1/story/download/by/url` — Download story file by URL to file
- `GET /v1/story/download/by/story/url` — Download story file by story URL

## Highlights

- `GET /v2/highlight/by/id` — Highlight By Id
- `GET /v1/highlight/by/url` — Attention! To work with /s/ links, call /v1/share/by/url first
- `GET /gql/highlight/by/id` — Get a web highlight GraphQL response by id

## Shop

- `GET /v1/shop/about` — Shop About
- `GET /v1/shop/products/by_collection/chunk` — Shop Products By Collection Chunk
- `GET /v1/shop/storefront` — Shop Storefront

## Share

- `GET /v1/share/reel/by/url` — Works for reel (clips) only
- `GET /v1/share/by/code` — Works for stories and highlights only or use (/v1/media/by/url, /v1/story/by/url)
- `GET /v1/share/by/url` — 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)

## System

- `GET /sys/balance` — Requests left and money on the account (free, not billed)
