Instaloader

https://instaloader.github.io/
Admin
Instaloader is a tool to download pictures, videos, captions, and metadata from Instagram profiles,...
Tokens:69,584
Snippets:770
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Instaloader and download a profile

Source: https://instaloader.github.io/index.html

Install Instaloader with pip3 and download a profile by running the instaloader command with the profile name. This is the basic installation and usage example from the introduction.

```bash
$ pip3 install instaloader

$ instaloader profile [profile ...]

```

--------------------------------

### Get Instaloader instance and optionally login

Source: https://instaloader.github.io/as-module.html

Start by creating an `Instaloader` instance. Optionally log in with a password, interactive login, or load a session file created with `instaloader -l USERNAME`.

```python
import instaloader

# Get instance
L = instaloader.Instaloader()

# Optionally, login or load session
L.login(USER, PASSWORD)        # (login)
L.interactive_login(USER)      # (ask password on terminal)
L.load_session_from_file(USER) # (load session created w/
                               #  `instaloader -l USERNAME`)
```

--------------------------------

### Show Instaloader help

Source: https://instaloader.github.io/cli-options.html

Run this command to get a list of all flags, their abbreviations, and descriptions.

```bash
instaloader --help

```

--------------------------------

### Install pre-release Instaloader with pip3

Source: https://instaloader.github.io/installation.html

Installs the most current pre-release version of Instaloader for testing.

```bash
pip3 install --pre instaloader
```

--------------------------------

### args.txt example

Source: https://instaloader.github.io/cli-options.html

Example of an args.txt file used with the +args.txt option. Arguments are separated by line breaks. This file can be used to hide login info from the CLI and simplify long argument management.

```text
--login=MYUSERNAME
--password=MYPASSWORD
--fast-update
profile1
profile2
```

--------------------------------

### Store posts in PROFILE/YEAR/SHORTCODE.jpg structure

Source: https://instaloader.github.io/basic-usage.html

Command-line example using --dirname-pattern and --filename-pattern to organize posts by profile, year, and shortcode.

```bash
instaloader --dirname-pattern={profile} --filename-pattern={date_utc:%Y}/{shortcode} <target> ...
```

--------------------------------

### Install Instaloader with pip3

Source: https://instaloader.github.io/installation.html

Installs the latest stable version of Instaloader. Requires Python 3.8 or newer and pip.

```bash
pip3 install instaloader
```

--------------------------------

### Download all visible user stories with Instaloader

Source: https://instaloader.github.io/module/structures.html

Use a logged-in Instaloader instance to iterate over stories and their items, downloading each story item to the ':stories' directory. The example shows the typical usage of get_stories() and get_items().

```python
for story in L.get_stories():
    # story is a Story object
    for item in story.get_items():
        # item is a StoryItem object
        L.download_storyitem(item, ':stories')

```

--------------------------------

### Pretty-format Instaloader JSON metadata with jq

Source: https://instaloader.github.io/codesnippets.html

Use this command to pretty-format a compressed Instaloader metadata JSON file. It decompresses the .xz file and pipes it to jq to extract the .node object. Requires jq to be installed.

```bash
xzcat 2018-05-13_11-18-45_UTC.json.xz | jq .node

```

--------------------------------

### Download a single post by shortcode

Source: https://instaloader.github.io/basic-usage.html

Use the -post target with the post's shortcode to download a single post. The command must be preceded by -- to avoid being interpreted as an option flag. Example: instaloader -- -B_K4CykAOtf

```bash
instaloader -- -B_K4CykAOtf
```

--------------------------------

### Download hashtag posts

Source: https://instaloader.github.io/module/instaloader.html

Example from the download_hashtag method documentation. Downloads the last 30 pictures with hashtag #cat.

```python
loader = Instaloader()
loader.download_hashtag('cat', max_count=30)
```

--------------------------------

### Iterate over posts from a hashtag

Source: https://instaloader.github.io/as-module.html

Use `Hashtag.from_name` to get a hashtag and iterate over its posts. Each post is an `instaloader.Post` instance, which can be downloaded with `download_post`.

```python
for post in instaloader.Hashtag.from_name(L.context, 'cat').get_posts():
    # post is an instance of instaloader.Post
    L.download_post(post, target='#cat')
```

--------------------------------

### Encode poster's profile name in filenames

Source: https://instaloader.github.io/basic-usage.html

Command-line example using --filename-pattern to include the profile name in the filename for a hashtag target.

```bash
instaloader --filename-pattern={date_utc}_UTC_{profile} "#hashtag"
```

--------------------------------

### Instaloader command-line options syntax

Source: https://instaloader.github.io/index.html

Shows the full command-line syntax for Instaloader, including options for comments, geotags, stories, highlights, tagged, reels, IGTV, login, and fast-update. Targets can be a profile, hashtag, location ID, or special targets like :stories, :feed, or :saved.

```bash
instaloader [--comments] [--geotags]
            [--stories] [--highlights] [--tagged] [--reels] [--igtv]
            [--login YOUR-USERNAME] [--fast-update]
            profile | "#hashtag" | %location_id |
            :stories | :feed | :saved

```

--------------------------------

### Import Firefox session cookies to bypass Instaloader login (Example 615_import_firefox_session.py)

Source: https://instaloader.github.io/troubleshooting.html

Use this script to work around Instaloader login problems by importing session cookies from Firefox. It reads cookies from Firefox's cookies.sqlite database, updates Instaloader's session, and saves a session file. Requires Firefox login to Instagram and Python with Instaloader installed. Supports optional -c and -f arguments for custom cookie and session file paths.

```python
from argparse import ArgumentParser
from glob import glob
from os.path import expanduser
from platform import system
from sqlite3 import OperationalError, connect

try:
    from instaloader import ConnectionException, Instaloader
except ModuleNotFoundError:
    raise SystemExit("Instaloader not found.\n  pip install [--user] instaloader")


def get_cookiefile():
    default_cookiefile = {
        "Windows": "~/AppData/Roaming/Mozilla/Firefox/Profiles/*/cookies.sqlite",
        "Darwin": "~/Library/Application Support/Firefox/Profiles/*/cookies.sqlite",
    }.get(system(), None)
    if default_cookiefile:
        cookiefiles = glob(expanduser(default_cookiefile))
    else:
        # Check Firefox 147+ XDG path, then legacy
        cookiefiles = glob(expanduser("~/.config/mozilla/firefox/*/cookies.sqlite")) or \
                      glob(expanduser("~/.mozilla/firefox/*/cookies.sqlite"))
    if not cookiefiles:
        raise SystemExit("No Firefox cookies.sqlite file found. Use -c COOKIEFILE.")
    return cookiefiles[0]


def import_session(cookiefile, sessionfile):
    print("Using cookies from {}.".format(cookiefile))
    conn = connect(f"file:{cookiefile}?immutable=1", uri=True)
    try:
        cookie_data = conn.execute(
            "SELECT name, value FROM moz_cookies WHERE baseDomain='instagram.com'"
        )
    except OperationalError:
        cookie_data = conn.execute(
            "SELECT name, value FROM moz_cookies WHERE host LIKE '%instagram.com'"
        )
    instaloader = Instaloader(max_connection_attempts=1)
    instaloader.context._session.cookies.update(cookie_data)
    username = instaloader.test_login()
    if not username:
        raise SystemExit("Not logged in. Are you logged in successfully in Firefox?")
    print("Imported session cookie for {}.".format(username))
    instaloader.context.username = username
    instaloader.save_session_to_file(sessionfile)


if __name__ == "__main__":
    p = ArgumentParser()
    p.add_argument("-c", "--cookiefile")
    p.add_argument("-f", "--sessionfile")
    args = p.parse_args()
    try:
        import_session(args.cookiefile or get_cookiefile(), args.sessionfile)
    except (ConnectionException, OperationalError) as e:
        raise SystemExit("Cookie import failed: {}".format(e))

```

--------------------------------

### Build documentation with Sphinx

Source: https://instaloader.github.io/contributing.html

Build the documentation locally using Sphinx version 2. Run this command from the project root.

```bash
make -C docs html

```

--------------------------------

### InstaloaderContext.get_and_write_raw()

Source: https://instaloader.github.io/module/instaloadercontext.html

Retrieves raw data from a URL and writes it to a file.

```APIDOC
## InstaloaderContext.get_and_write_raw()

### Description
Retrieves raw data from a URL and writes it to a file.

### Method
get_and_write_raw(url, filename)

### Parameters
- **url** (str) - Required - The URL to fetch.
- **filename** (str) - Required - The filename to write the data to.

### Returns
None
```

--------------------------------

### get_explore_posts

Source: https://instaloader.github.io/module/instaloader.html

Get Posts which are worthy of exploring suggested by Instagram.

```APIDOC
## get_explore_posts

### Description
Get Posts which are worthy of exploring suggested by Instagram.

### Method
N/A (Python method)

### Endpoint
N/A (Python method)

### Parameters
None.

### Response
Returns a NodeIterator[Post] of suggested posts.
```

--------------------------------

### Hashtag.get_posts_resumable

Source: https://instaloader.github.io/module/structures.html

Get the recent posts of the hashtag in a resumable fashion.

```APIDOC
## Hashtag.get_posts_resumable

### Description
Get the recent posts of the hashtag in a resumable fashion.

### Method
NodeIterator[Post]

### Return type
NodeIterator[Post]

### Added in Version
4.9
```

--------------------------------

### InstaloaderContext.head()

Source: https://instaloader.github.io/module/instaloadercontext.html

Sends a HEAD request to a URL.

```APIDOC
## InstaloaderContext.head()

### Description
Sends a HEAD request to a URL.

### Method
head(url)

### Parameters
- **url** (str) - Required - The URL to send the HEAD request to.

### Returns
- **requests.Response** - The response object.
```

--------------------------------

### get_feed_posts()

Source: https://instaloader.github.io/module/instaloader.html

Get Posts of the user's feed. Requires being logged in.

```APIDOC
## get_feed_posts()

### Description
Get Posts of the user's feed.

### Method
GET

### Endpoint
Instaloader.get_feed_posts()

### Parameters
None

### Response
#### Success Response
- **Iterator[Post]** - Iterator over Posts of the user's feed.

### Errors
- **LoginRequiredException** – If called without being logged in.
```

--------------------------------

### Iterate over posts from a hashtag and download them

Source: https://instaloader.github.io/module/structures.html

Creates an Instaloader instance, iterates over posts from a hashtag, and downloads each post to a target directory.

```python
L = Instaloader()
for post in L.get_hashtag_posts(HASHTAG):
    L.download_post(post, target='#'+HASHTAG)
```

--------------------------------

### Profile.get_saved_posts()

Source: https://instaloader.github.io/module/structures.html

Gets Posts that are marked as saved by the user. Returns a NodeIterator of Post objects.

```APIDOC
## Profile.get_saved_posts()

### Description
Get Posts that are marked as saved by the user.

### Method
get_saved_posts

### Return Type
NodeIterator[Post]
```

--------------------------------

### TopSearchResults.get_prefixed_usernames()

Source: https://instaloader.github.io/module/structures.html

Returns an iterator over profile names from the search result that start with the search string.

```APIDOC
## get_prefixed_usernames()

### Description
Provides all profile names from the search result that start with the search string.

### Method
Iterator method

### Returns
Iterator[str] - An iterator over profile name strings.

```

--------------------------------

### Instaloader Constructor

Source: https://instaloader.github.io/module/instaloader.html

Creates an Instaloader instance with configurable options for downloading behavior, network settings, and file naming.

```APIDOC
## Instaloader Constructor

### Description
Creates an Instaloader instance with configurable options for downloading behavior, network settings, and file naming.

### Method
Constructor

### Signature
`Instaloader(_sleep: bool = True, _quiet: bool = False, _user_agent: str | None = None, _dirname_pattern: str | None = None, _filename_pattern: str | None = None, _download_pictures: bool = True, _download_videos: bool = True, _download_video_thumbnails: bool = True, _download_geotags: bool = False, _download_comments: bool = False, _save_metadata: bool = True, _compress_json: bool = True, _post_metadata_txt_pattern: str | None = None, _storyitem_metadata_txt_pattern: str | None = None, _max_connection_attempts: int = 3, _request_timeout: float = 300.0, _rate_controller: Callable[[InstaloaderContext], RateController] | None = None, _resume_prefix: str | None = 'iterator', _check_resume_bbd: bool = True, _slide: str | None = None, _fatal_status_codes: List[int] | None = None, _iphone_support: bool = True, _title_pattern: str | None = None, _sanitize_paths: bool = False)`

### Parameters
- **quiet** (bool) - Optional - If True, suppress output. Corresponds to `--quiet`.
- **user_agent** (str) - Optional - User agent string for requests. Corresponds to `--user-agent`.
- **dirname_pattern** (str) - Optional - Directory name pattern for downloads. Default is `{target}`. Corresponds to `--dirname-pattern`.
- **filename_pattern** (str) - Optional - Filename pattern for downloads. Default is `{date_utc}_UTC`. Corresponds to `--filename-pattern`.
- **title_pattern** (str) - Optional - Title pattern for downloads. Default is `{date_utc}_UTC_{typename}` if `dirname_pattern` contains `{target}` or `{profile}`, otherwise `{target}_{date_utc}_UTC_{typename}`. Corresponds to `--title-pattern`.
- **download_pictures** (bool) - Optional - Whether to download pictures. Default True. Corresponds to not `--no-pictures`.
- **download_videos** (bool) - Optional - Whether to download videos. Default True. Corresponds to not `--no-videos`.
- **download_video_thumbnails** (bool) - Optional - Whether to download video thumbnails. Default True. Corresponds to not `--no-video-thumbnails`.
- **download_geotags** (bool) - Optional - Whether to download geotags. Default False. Corresponds to `--geotags`.
- **download_comments** (bool) - Optional - Whether to download comments. Default False. Corresponds to `--comments`.
- **save_metadata** (bool) - Optional - Whether to save metadata as JSON. Default True. Corresponds to not `--no-metadata-json`.
- **compress_json** (bool) - Optional - Whether to compress JSON metadata. Default True. Corresponds to not `--no-compress-json`.
- **post_metadata_txt_pattern** (str) - Optional - Pattern for post metadata text file. Default is `{caption}`. Set to empty string to avoid creation. Corresponds to `--post-metadata-txt`.
- **storyitem_metadata_txt_pattern** (str) - Optional - Pattern for story item metadata text file. Default is empty (none). Corresponds to `--storyitem-metadata-txt`.
- **max_connection_attempts** (int) - Optional - Maximum number of connection attempts. Default 3. Corresponds to `--max-connection-attempts`.
- **request_timeout** (float) - Optional - Per-request timeout in seconds. Default 300.0. Corresponds to `--request-timeout`.
- **rate_controller** (Callable) - Optional - Generator for a `RateController` to override rate controlling behavior.
- **resume_prefix** (str) - Optional - Prefix for resume files. Default 'iterator'. Set to None for `--no-resume`. Corresponds to `--resume-prefix`.
- **check_resume_bbd** (bool) - Optional - Whether to check expiry date of resume files and reject if expired. Default True.
- **slide** (str) - Optional - Slide parameter. Corresponds to `--slide`.
- **fatal_status_codes** (List[int]) - Optional - HTTP status codes that abort the program. Corresponds to `--abort-on`.
- **iphone_support** (bool) - Optional - Whether to use iPhone support. Default True. Corresponds to not `--no-iphone`.
- **sanitize_paths** (bool) - Optional - Whether to sanitize paths. Default False. Corresponds to `--sanitize-paths`.

### Returns
An Instaloader instance.
```

--------------------------------

### get_location_posts(location)

Source: https://instaloader.github.io/module/instaloader.html

Get Posts which are listed by Instagram for a given Location. Requires being logged in as of version 4.2.9.

```APIDOC
## get_location_posts(location)

### Description
Get Posts which are listed by Instagram for a given Location. Requires being logged in as of version 4.2.9.

### Method
GET

### Endpoint
Instaloader.get_location_posts(location)

### Parameters
#### Path Parameters
- **location** (str) - Required - The location to get posts for.

### Response
#### Success Response
- **Iterator[Post]** - Iterator over Posts of a location's posts.

### Errors
- **LoginRequiredException** – If called without being logged in.
```

--------------------------------

### InstaloaderContext.log()

Source: https://instaloader.github.io/module/instaloadercontext.html

Logs a message.

```APIDOC
## InstaloaderContext.log()

### Description
Logs a message.

### Method
log(msg)

### Parameters
- **msg** (str) - Required - The message to log.

### Returns
None
```

--------------------------------

### get_highlights(user)

Source: https://instaloader.github.io/module/instaloader.html

Get all highlights from a user. To use this, one needs to be logged in. Added in version 4.1.

```APIDOC
## get_highlights(user)

### Description
Get all highlights from a user. To use this, one needs to be logged in. Added in version 4.1.

### Method
GET

### Endpoint
Instaloader.get_highlights(user)

### Parameters
#### Path Parameters
- **user** (int | Profile) - Required - ID or Profile of the user whose highlights should get fetched.

### Response
#### Success Response
- **Iterator[Highlight]** - Iterator over highlights.

### Errors
- **LoginRequiredException** – If called without being logged in.
```

--------------------------------

### get_hashtag_posts(hashtag)

Source: https://instaloader.github.io/module/instaloader.html

Get Posts associated with a #hashtag. Deprecated since version 4.4: Use Hashtag.get_posts_resumable().

```APIDOC
## get_hashtag_posts(hashtag)

### Description
Get Posts associated with a #hashtag. Deprecated since version 4.4: Use Hashtag.get_posts_resumable().

### Method
GET

### Endpoint
Instaloader.get_hashtag_posts(hashtag)

### Parameters
#### Path Parameters
- **hashtag** (str) - Required - The hashtag to get posts for.

### Response
#### Success Response
- **Iterator[Post]** - Iterator over Posts associated with the hashtag.
```

--------------------------------

### InstaloaderContext.write_raw()

Source: https://instaloader.github.io/module/instaloadercontext.html

Writes raw data to a file.

```APIDOC
## InstaloaderContext.write_raw()

### Description
Writes raw data to a file.

### Method
write_raw(data, filename)

### Parameters
- **data** (bytes) - Required - The raw data to write.
- **filename** (str) - Required - The file to write to.

### Returns
None
```

--------------------------------

### InstaloaderContext.get_and_write_raw(url, filename)

Source: https://instaloader.github.io/module/instaloadercontext.html

Downloads and writes anonymously-requested raw data into a file.

```APIDOC
## get_and_write_raw(url, filename)

### Description
Downloads and writes anonymously-requested raw data into a file.

### Method
get_and_write_raw

### Parameters
#### Path Parameters
- **url** (str) - Required - URL to download.
- **filename** (str) - Required - Filename to write the data to.

### Raises
- **QueryReturnedNotFoundException** - When the server responds with a 404.
- **QueryReturnedForbiddenException** - When the server responds with a 403.
- **ConnectionException** - When download repeatedly failed.

### Returns
None

```

--------------------------------

### Post.get_sidecar_nodes(start=0, end=-1)

Source: https://instaloader.github.io/module/structures.html

Returns sidecar nodes of a Post with typename==GraphSidecar. Parameters start and end specify a slice of sidecar media.

```APIDOC
## Post.get_sidecar_nodes(start=0, end=-1)

### Description
Returns sidecar nodes of a Post with typename==GraphSidecar. Parameters start and end specify a slice of sidecar media.

### Method
Instance method

### Parameters
- **start** (int) - Optional - Start index for slicing. Default 0.
- **end** (int) - Optional - End index for slicing. Default -1 (all).

### Returns
- **Iterator[PostSidecarNode]** - An iterator of PostSidecarNode objects.
```

--------------------------------

### InstaloaderContext.get_raw(url, _attempt=1)

Source: https://instaloader.github.io/module/instaloadercontext.html

Downloads a file anonymously.

```APIDOC
## get_raw(url, _attempt=1)

### Description
Downloads a file anonymously. Added in version 4.2.1.

### Method
get_raw

### Parameters
#### Path Parameters
- **url** (str) - Required - URL to download.
- **_attempt** (int) - Optional - Internal attempt counter.

### Returns
requests.Response - The response object.

### Raises
- **QueryReturnedNotFoundException** - When the server responds with a 404.
- **QueryReturnedForbiddenException** - When the server responds with a 403.
- **ConnectionException** - When download failed.

```

--------------------------------

### InstaloaderContext.load_session_from_file()

Source: https://instaloader.github.io/module/instaloadercontext.html

Loads a session from a file.

```APIDOC
## InstaloaderContext.load_session_from_file()

### Description
Loads a session from a file.

### Method
load_session_from_file(username, filename)

### Parameters
- **username** (str) - Required - The username associated with the session.
- **filename** (str) - Required - The file to load the session from.

### Returns
None
```

--------------------------------

### get_stories(userids=None)

Source: https://instaloader.github.io/module/instaloader.html

Get available stories from followees or all stories of users whose ID are given. Does not mark stories as seen. To use this, one needs to be logged in.

```APIDOC
## get_stories(userids=None)

### Description
Get available stories from followees or all stories of users whose ID are given. Does not mark stories as seen. To use this, one needs to be logged in.

### Method
GET

### Endpoint
Instaloader.get_stories(userids=None)

### Parameters
#### Query Parameters
- **userids** (List[int] | None) - Optional - List of user IDs to be processed in terms of downloading their stories, or None.

### Response
#### Success Response
- **Iterator[Story]** - Iterator over stories.

### Errors
- **LoginRequiredException** – If called without being logged in.
```

--------------------------------

### download_profile(_profile_name: str | Profile, _profile_pic: bool = True, _profile_pic_only: bool = False, _fast_update: bool = False, _download_stories: bool = False, _download_stories_only: bool = False, _download_tagged: bool = False, _download_tagged_only: bool = False, _post_filter: Callable[[Post], bool] | None = None, _storyitem_filter: Callable[[StoryItem], bool] | None = None) -> None

Source: https://instaloader.github.io/module/instaloader.html

Download one profile. Deprecated since version 4.1: Use Instaloader.download_profiles().

```APIDOC
## download_profile(_profile_name: str | Profile, _profile_pic: bool = True, _profile_pic_only: bool = False, _fast_update: bool = False, _download_stories: bool = False, _download_stories_only: bool = False, _download_tagged: bool = False, _download_tagged_only: bool = False, _post_filter: Callable[[Post], bool] | None = None, _storyitem_filter: Callable[[StoryItem], bool] | None = None) -> None

### Description
Download one profile.

### Method
SDK Method

### Signature
`download_profile(_profile_name: str | Profile, _profile_pic: bool = True, _profile_pic_only: bool = False, _fast_update: bool = False, _download_stories: bool = False, _download_stories_only: bool = False, _download_tagged: bool = False, _download_tagged_only: bool = False, _post_filter: Callable[[Post], bool] | None = None, _storyitem_filter: Callable[[StoryItem], bool] | None = None) -> None`

### Parameters
- **profile_name** (str | Profile) - Required - The profile name or Profile object to download.
- **profile_pic** (bool) - Optional - Whether to download the profile picture. Default True.
- **profile_pic_only** (bool) - Optional - Whether to download only the profile picture. Default False.
- **fast_update** (bool) - Optional - If true, abort when first already-downloaded picture is encountered.
- **download_stories** (bool) - Optional - Whether to download stories. Default False.
- **download_stories_only** (bool) - Optional - Whether to download only stories. Default False.
- **download_tagged** (bool) - Optional - Whether to download tagged posts. Default False.
- **download_tagged_only** (bool) - Optional - Whether to download only tagged posts. Default False.
- **post_filter** (Callable[[Post], bool] | None) - Optional - function(post), which returns True if given picture should be downloaded.
- **storyitem_filter** (Callable[[StoryItem], bool] | None) - Optional - function(storyitem), which returns True if given StoryItem should be downloaded.

### Returns
None

### Deprecation
Deprecated since version 4.1: Use `Instaloader.download_profiles()`.
```

--------------------------------

### NodeIterator

Source: https://instaloader.github.io/module/nodeiterator.html

An interruptible iterator that can be frozen and thawed to resume iteration. Provides methods to count items, access the first item, freeze and thaw the iterator, and get the page length.

```APIDOC
## NodeIterator

### Description
An interruptible iterator that can be frozen and thawed to resume iteration. Provides methods to count items, access the first item, freeze and thaw the iterator, and get the page length.

### Methods
- **count** - Returns the number of items iterated so far.
- **first_item** - Returns the first item of the iteration.
- **freeze()** - Freezes the iterator, returning a FrozenNodeIterator that can be used to resume later.
- **magic** - A magic attribute (exact purpose not specified in source).
- **page_length()** - Returns the number of items per page.
- **thaw()** - Thaws a frozen iterator to resume iteration.
- **total_index** - Returns the total index of the current item.

### Attributes
- **count** (int) - Number of items iterated so far.
- **first_item** (object) - The first item of the iteration.
- **magic** (unknown) - A magic attribute.
- **total_index** (int) - The total index of the current item.

### Usage Example
```python
# Example usage (not provided in source)
```
```

--------------------------------

### InstaloaderContext.get_raw()

Source: https://instaloader.github.io/module/instaloadercontext.html

Retrieves raw data from a URL.

```APIDOC
## InstaloaderContext.get_raw()

### Description
Retrieves raw data from a URL.

### Method
get_raw(url)

### Parameters
- **url** (str) - Required - The URL to fetch.

### Returns
- **bytes** - The raw response data.
```

--------------------------------

### Download all highlights of a profile with Instaloader

Source: https://instaloader.github.io/module/structures.html

Use this snippet with a logged-in Instaloader instance L to download all highlights of a Profile instance USER. It iterates over highlights from L.get_highlights(USER), then over each highlight's items via highlight.get_items(), and downloads each StoryItem using L.download_storyitem(). The output path is formatted as '{highlight.owner_username}/{highlight.title}'.

```python
for highlight in L.get_highlights(USER):
    # highlight is a Highlight object
    for item in highlight.get_items():
        # item is a StoryItem object
        L.download_storyitem(item, '{}/{}'.format(highlight.owner_username, highlight.title))

```

--------------------------------

### Download last 30 pictures from a location

Source: https://instaloader.github.io/module/instaloader.html

Example usage of the download_location method to download the last 30 pictures from a specific Instagram location ID. Requires being logged in as of version 4.2.9.

```python
loader = Instaloader()
loader.download_location(362629379, max_count=30)
```

--------------------------------

### Download feed posts with post_filter

Source: https://instaloader.github.io/module/instaloader.html

Example from the download_feed_posts method documentation. Downloads up to 20 posts the user last liked, using fast_update and a post_filter that checks viewer_has_liked. Requires being logged in (load_session_from_file).

```python
loader = Instaloader()
loader.load_session_from_file('USER')
loader.download_feed_posts(max_count=20, fast_update=True,
                           post_filter=lambda post: post.viewer_has_liked)
```

--------------------------------

### Instaloader()

Source: https://instaloader.github.io/as-module.html

Creates an instance of the Instaloader main class, which provides methods for downloading and iterating over Instagram content.

```APIDOC
## Instaloader()

### Description
Creates an instance of the Instaloader main class, which provides methods for downloading and iterating over Instagram content.

### Method
Constructor

### Usage
```python
import instaloader
L = instaloader.Instaloader()
```

```

--------------------------------

### Invoke Instaloader with options and targets

Source: https://instaloader.github.io/cli-options.html

Basic command line invocation of Instaloader. The target can be a profile, hashtag, @profile, %location ID, or special targets like :feed, :stories, or :saved.

```bash
$ instaloader [options] target [target ...]

```

--------------------------------

### Export likes and comments from JSON files

Source: https://instaloader.github.io/basic-usage.html

Reimport already-downloaded JSON files to extract additional metadata. This example exports both likes and comments counts for each post by specifying multiple fields in --post-metadata-txt.

```bash
instaloader --post-metadata-txt="{likes} likes, {comments} comments." <target>/*.json.xz

```

--------------------------------

### InstaloaderContext.graphql_query()

Source: https://instaloader.github.io/module/instaloadercontext.html

Executes a GraphQL query.

```APIDOC
## InstaloaderContext.graphql_query()

### Description
Executes a GraphQL query.

### Method
graphql_query(query_hash, query_variables)

### Parameters
- **query_hash** (str) - Required - The hash of the GraphQL query.
- **query_variables** (dict) - Required - The variables for the query.

### Returns
- **dict** - The JSON response.
```

--------------------------------

### login

Source: https://instaloader.github.io/module/instaloadercontext.html

Performs login. Not meant to be used directly; use Instaloader.login() instead.

```APIDOC
## login

### Description
Not meant to be used directly, use `Instaloader.login()`.

### Method
Function call

### Signature
`login(_user, _passwd)`

### Parameters
- **user** - Required - The username.
- **passwd** - Required - The password.

### Raises
- **BadCredentialsException** – If the provided password is wrong.
- **TwoFactorAuthRequiredException** – First step of 2FA login done, now call `Instaloader.two_factor_login()`.
- **LoginException** – An error happened during login (for example, and invalid response). Or if the provided username does not exist.

### Notes
Changed in version 4.12: Raises LoginException instead of ConnectionException when an error happens. Raises LoginException instead of InvalidArgumentException when the username does not exist.
```

--------------------------------

### Save likes count with --post-metadata-txt

Source: https://instaloader.github.io/basic-usage.html

Use --post-metadata-txt to customize the metadata text file content. The example saves the number of likes for each post instead of the caption. The string is formatted similarly to path patterns and field names are evaluated as Post attributes.

```bash
instaloader --post-metadata-txt="{likes} likes." <target>

```

--------------------------------

### InstaloaderContext.two_factor_login()

Source: https://instaloader.github.io/module/instaloadercontext.html

Completes two-factor authentication login.

```APIDOC
## InstaloaderContext.two_factor_login()

### Description
Completes two-factor authentication login.

### Method
two_factor_login(code)

### Parameters
- **code** (str) - Required - The two-factor authentication code.

### Returns
None
```

--------------------------------

### Create Instaloader session file

Source: https://instaloader.github.io/basic-usage.html

Run this command to create a session file for your Instagram account. It will prompt for your password and save the session to ~/.config/instaloader/session-YOUR-USERNAME.

```bash
instaloader --login=your_username

```

--------------------------------

### InstaloaderContext.error_catcher(extra_info=None)

Source: https://instaloader.github.io/module/instaloadercontext.html

Context manager to catch, print and record InstaloaderExceptions.

```APIDOC
## error_catcher(extra_info=None)

### Description
Context manager to catch, print and record InstaloaderExceptions.

### Method
error_catcher

### Parameters
#### Path Parameters
- **extra_info** (str | None) - Optional - String to prefix error message with.

### Returns
Context manager.

```

--------------------------------

### InstaloaderContext.get_json()

Source: https://instaloader.github.io/module/instaloadercontext.html

Retrieves JSON data from a URL.

```APIDOC
## InstaloaderContext.get_json()

### Description
Retrieves JSON data from a URL.

### Method
get_json(path, params=None, headers=None)

### Parameters
- **path** (str) - Required - The path of the endpoint.
- **params** (dict) - Optional - Query parameters.
- **headers** (dict) - Optional - HTTP headers.

### Returns
- **dict** - The JSON response.
```

--------------------------------

### InstaloaderContext.login()

Source: https://instaloader.github.io/module/instaloadercontext.html

Logs in to Instagram.

```APIDOC
## InstaloaderContext.login()

### Description
Logs in to Instagram.

### Method
login(username, password)

### Parameters
- **username** (str) - Required - The Instagram username.
- **password** (str) - Required - The Instagram password.

### Returns
None
```

--------------------------------

### instaloader.load_structure_from_file(context, filename)

Source: https://instaloader.github.io/module/structures.html

Loads a Post, Profile, StoryItem, Hashtag, or FrozenNodeIterator from a '.json' or '.json.xz' file that has been saved by save_structure_to_file().

```APIDOC
## instaloader.load_structure_from_file(context, filename)

### Description
Loads a `Post`, `Profile`, `StoryItem`, `Hashtag` or `FrozenNodeIterator` from a '.json' or '.json.xz' file that has been saved by `save_structure_to_file()`.

### Method
Function

### Signature
`instaloader.load_structure_from_file(context: InstaloaderContext, filename: str) -> Post | Profile | StoryItem | Hashtag | FrozenNodeIterator`

### Parameters
- **context** (InstaloaderContext) - Required - `Instaloader.context` linked to the new object, used for additional queries if necessary.
- **filename** (str) - Required - Filename, ends in '.json' or '.json.xz'
```

--------------------------------

### instaloader.load_structure(context, json_structure)

Source: https://instaloader.github.io/module/structures.html

Loads a Post, Profile, StoryItem, Hashtag, or FrozenNodeIterator from a JSON structure. The context is used for additional queries if necessary.

```APIDOC
## instaloader.load_structure(context, json_structure)

### Description
Loads a `Post`, `Profile`, `StoryItem`, `Hashtag` or `FrozenNodeIterator` from a json structure.

### Method
Function

### Signature
`instaloader.load_structure(context: InstaloaderContext, json_structure: dict) -> Post | Profile | StoryItem | Hashtag | FrozenNodeIterator`

### Parameters
- **context** (InstaloaderContext) - Required - `Instaloader.context` linked to the new object, used for additional queries if necessary.
- **json_structure** (dict) - Required - Instaloader JSON structure

### Notes
Added in version 4.8.
```

--------------------------------

### InstaloaderContext.close()

Source: https://instaloader.github.io/module/instaloadercontext.html

Prints error log and closes the session.

```APIDOC
## close()

### Description
Print error log and close session.

### Method
close

### Parameters
None

### Returns
None

```

--------------------------------

### InstaloaderContext.load_session()

Source: https://instaloader.github.io/module/instaloadercontext.html

Loads a session from a session object.

```APIDOC
## InstaloaderContext.load_session()

### Description
Loads a session from a session object.

### Method
load_session(session)

### Parameters
- **session** (requests.Session) - Required - The session object to load.

### Returns
None
```

--------------------------------

### Run Instaloader as cronjob with session

Source: https://instaloader.github.io/basic-usage.html

Use this command in a cronjob to load the session created earlier and download the given targets. The --quiet option disables user interactions and non-error logging.

```bash
instaloader --login=your_username --quiet target [...]

```

--------------------------------

### InstaloaderContext.error()

Source: https://instaloader.github.io/module/instaloadercontext.html

Logs an error message.

```APIDOC
## InstaloaderContext.error()

### Description
Logs an error message.

### Method
error(msg, repeat_at_end=False)

### Parameters
- **msg** (str) - Required - The error message to log.
- **repeat_at_end** (bool) - Optional - Whether to repeat the error at the end of the session.

### Returns
None
```

--------------------------------

### Find Ghost Followers (Inactive Followers) with Instaloader

Source: https://instaloader.github.io/codesnippets.html

This script loads a session, fetches all likes from the profile's posts, and compares them with the follower list to identify followers who have not liked any posts. It writes the usernames of these 'ghost' followers to 'inactive-users.txt'. Requires a previously saved session via `instaloader -l USERNAME`.

```python
import instaloader

L = instaloader.Instaloader()

USER = "your_account"
PROFILE = USER

# Load session previously saved with `instaloader -l USERNAME`:
L.load_session_from_file(USER)

profile = instaloader.Profile.from_username(L.context, PROFILE)

likes = set()
print("Fetching likes of all posts of profile {}.".format(profile.username))
for post in profile.get_posts():
    print(post)
    likes = likes | set(post.get_likes())

print("Fetching followers of profile {}.".format(profile.username))
followers = set(profile.get_followers())

ghosts = followers - likes

print("Storing ghosts into file.")
with open("inactive-users.txt", 'w') as f:
    for ghost in ghosts:
        print(ghost.username, file=f)

```

--------------------------------

### Create Hashtag instance with Hashtag.from_name

Source: https://instaloader.github.io/module/structures.html

Shows how to obtain a Hashtag instance using the from_name classmethod. Requires an Instaloader instance and a hashtag name without the leading '#'.

```python
L = Instaloader()
hashtag = Hashtag.from_name(L.context, HASHTAG)
```

--------------------------------

### download_igtv(_profile: Profile, _fast_update: bool = False, _post_filter: Callable[[Post], bool] | None = None, _latest_stamps: LatestStamps | None = None) -> None

Source: https://instaloader.github.io/module/instaloader.html

Download IGTV videos of a profile. Added in version 4.3, changed in version 4.8 to add latest_stamps parameter.

```APIDOC
## download_igtv(_profile: Profile, _fast_update: bool = False, _post_filter: Callable[[Post], bool] | None = None, _latest_stamps: LatestStamps | None = None) -> None

### Description
Download IGTV videos of a profile.

### Method
SDK Method

### Signature
`download_igtv(_profile: Profile, _fast_update: bool = False, _post_filter: Callable[[Post], bool] | None = None, _latest_stamps: LatestStamps | None = None) -> None`

### Parameters
- **profile** (Profile) - Required - The profile to download IGTV videos from.
- **fast_update** (bool) - Optional - If true, abort when first already-downloaded picture is encountered.
- **post_filter** (Callable[[Post], bool] | None) - Optional - function(post), which returns True if given picture should be downloaded.
- **latest_stamps** (LatestStamps | None) - Optional - Database with the last downloaded data.

### Returns
None

### Notes
Added in version 4.3. Changed in version 4.8: Add latest_stamps parameter.
```

--------------------------------

### Profile.from_username(context, username)

Source: https://instaloader.github.io/module/structures.html

Creates a Profile instance from a given username. Raises ProfileNotExistsException if the profile does not exist.

```APIDOC
## Profile.from_username(context, username)

### Description
Creates a Profile instance from a given username. Raises ProfileNotExistsException if the profile does not exist.

### Method
classmethod

### Parameters
- **context** (InstaloaderContext) - Required - The Instaloader context.
- **username** (str) - Required - The username of the profile.

### Raises
- ProfileNotExistsException - If the profile does not exist.

### Example
```
L = Instaloader()
profile = Profile.from_username(L.context, USERNAME)
```
```

--------------------------------

### InstaloaderContext.anonymous_copy()

Source: https://instaloader.github.io/module/instaloadercontext.html

Creates a copy of the context with anonymous session.

```APIDOC
## anonymous_copy()

### Description
Creates a copy of the context with anonymous session.

### Method
anonymous_copy

### Parameters
None

### Returns
A copy of the context with anonymous session.

```

--------------------------------

### Instaloader.get_explore_posts()

Source: https://instaloader.github.io/as-module.html

Returns an iterator over media that is suggested by Instagram to explore.

```APIDOC
## Instaloader.get_explore_posts()

### Description
Returns an iterator over media that is suggested by Instagram to explore.

### Method
Method

### Usage
```python
for post in L.get_explore_posts():
    # process post
```

```

--------------------------------

### Instaloader.get_feed_posts()

Source: https://instaloader.github.io/as-module.html

Returns an iterator over media in the user's feed.

```APIDOC
## Instaloader.get_feed_posts()

### Description
Returns an iterator over media in the user's feed.

### Method
Method

### Usage
```python
for post in L.get_feed_posts():
    # process post
```

```

--------------------------------

### InstaloaderContext.graphql_node_list()

Source: https://instaloader.github.io/module/instaloadercontext.html

Retrieves a list of nodes from a GraphQL query.

```APIDOC
## InstaloaderContext.graphql_node_list()

### Description
Retrieves a list of nodes from a GraphQL query.

### Method
graphql_node_list(query_hash, query_variables, entity_path, edge_extractor)

### Parameters
- **query_hash** (str) - Required - The hash of the GraphQL query.
- **query_variables** (dict) - Required - The variables for the query.
- **entity_path** (str) - Required - The path to the entity in the response.
- **edge_extractor** (callable) - Required - A function to extract edges from the response.

### Returns
- **list** - A list of nodes.
```

--------------------------------

### InstaloaderContext.get_json(path, params, host='www.instagram.com', session=None, _attempt=1, response_headers=None, use_post=False)

Source: https://instaloader.github.io/module/instaloadercontext.html

Performs a JSON request to Instagram.

```APIDOC
## get_json(path, params, host='www.instagram.com', session=None, _attempt=1, response_headers=None, use_post=False)

### Description
JSON request to Instagram. Changed in version 4.13: Added use_post parameter.

### Method
get_json

### Parameters
#### Path Parameters
- **path** (str) - Required - URL, relative to the given domain which defaults to www.instagram.com/
- **params** (Dict[str, Any]) - Required - request parameters
- **host** (str) - Optional - Domain part of the URL from where to download the requested JSON; defaults to www.instagram.com
- **session** (Session | None) - Optional - Session to use, or None to use self.session
- **_attempt** (int) - Optional - Internal attempt counter.
- **response_headers** (Dict[str, Any] | None) - Optional - Response headers.
- **use_post** (bool) - Optional - Use POST instead of GET to make the request

### Returns
Decoded response dictionary.

### Raises
- **AbortDownloadException** - When the server responds with 'feedback_required'/'checkpoint_required'/'challenge_required'
- **QueryReturnedBadRequestException** - When the server responds with a 400 (and not 'feedback_required'/'checkpoint_required'/'challenge_required').
- **QueryReturnedNotFoundException** - When the server responds with a 404.
- **ConnectionException** - When query repeatedly failed.

```

--------------------------------

### InstaloaderContext.save_session_to_file()

Source: https://instaloader.github.io/module/instaloadercontext.html

Saves the current session to a file.

```APIDOC
## InstaloaderContext.save_session_to_file()

### Description
Saves the current session to a file.

### Method
save_session_to_file(filename)

### Parameters
- **filename** (str) - Required - The file to save the session to.

### Returns
None
```

--------------------------------

### Upgrade Instaloader with pip3

Source: https://instaloader.github.io/installation.html

Upgrades Instaloader to the current version.

```bash
pip3 install --upgrade instaloader
```

--------------------------------

### Create Profile from username

Source: https://instaloader.github.io/as-module.html

Create a `Profile` object using its username.

```python
profile = Profile.from_username(L.context, USERNAME)
```

--------------------------------

### Iterate Over Profile Posts

Source: https://instaloader.github.io/module/structures.html

Iterates over all posts from a profile and downloads them using Instaloader.download_post().

```python
for post in profile.get_posts():
    L.download_post(post, target=profile.username)
```

--------------------------------

### Profile.from_iphone_struct(context, media)

Source: https://instaloader.github.io/module/structures.html

Creates a Profile instance from a given iphone_struct. Added in version 4.9.

```APIDOC
## Profile.from_iphone_struct(context, media)

### Description
Creates a profile from a given iphone_struct. Added in version 4.9.

### Method
classmethod

### Parameters
- **context** (InstaloaderContext) - Required - The Instaloader context.
- **media** (Dict[str, Any]) - Required - The iphone_struct data.
```
Tokens:
Raw