mirror of
https://github.com/instaloader/instaloader.git
synced 2024-08-17 20:29:38 +02:00
7c76202f1c
as-module.rst: List how Post and Profile is created Describe new filename specification logic Update filter-posts section
184 lines
4.5 KiB
ReStructuredText
184 lines
4.5 KiB
ReStructuredText
.. meta::
|
|
:description:
|
|
Documentation of Instaloader module, a powerful and intuitive
|
|
Python library to download Instagram media and metadata.
|
|
|
|
Python Module :mod:`instaloader`
|
|
--------------------------------
|
|
|
|
.. module:: instaloader
|
|
|
|
.. highlight:: python
|
|
|
|
.. contents::
|
|
:backlinks: none
|
|
|
|
Instaloader exposes its internally used methods and structures as a Python
|
|
module, making it a **powerful and intuitive Python API for Instagram**,
|
|
allowing to further customize obtaining media and metadata.
|
|
|
|
Start with getting an instance of :class:`Instaloader`::
|
|
|
|
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`)
|
|
|
|
:mod:`instaloader` provides the :class:`Post` structure, which represents a
|
|
picture, video or sidecar (set of multiple pictures/videos) posted in a user's
|
|
profile. :class:`Instaloader` provides methods to iterate over Posts from a
|
|
certain source::
|
|
|
|
for post in L.get_hashtag_posts('cat'):
|
|
# post is an instance of instaloader.Post
|
|
L.download_post(post, target='#cat')
|
|
|
|
:class:`Post` instances can be created with:
|
|
|
|
- :func:`Post.from_shortcode`
|
|
Use a Post shortcode (part of the Post URL,
|
|
``https://www.instagram.com/p/SHORTCODE/``) to create a Post
|
|
object::
|
|
|
|
post = Post.from_shortcode(L.context, SHORTCODE)
|
|
|
|
- :meth:`Profile.get_posts`
|
|
All media of a :class:`Profile`.
|
|
|
|
- :meth:`Profile.get_saved_posts`
|
|
Media that the user marked as saved (:class:`Profile` must be own profile
|
|
for this to work)
|
|
|
|
- :meth:`Instaloader.get_feed_posts`
|
|
Media in the user's feed.
|
|
|
|
- :meth:`Instaloader.get_explore_posts`
|
|
Media that is suggested by Instagram to explore.
|
|
|
|
- :meth:`Instaloader.get_hashtag_posts`
|
|
Media associated with given hashtag.
|
|
|
|
With the :class:`Profile` class, Instaloader also makes it easy to access
|
|
metadata of a Profile. :class:`Profile` instances can be created with:
|
|
|
|
- :meth:`Profile.from_username`::
|
|
|
|
profile = Profile.from_username(L.context, USERNAME)
|
|
|
|
- :meth:`Profile_from_userid`
|
|
given its User ID (currently requires to be logged in).
|
|
|
|
- :meth:`Profile.get_followees`
|
|
Profiles that are followed by given user.
|
|
|
|
- :meth:`Profile.get_followers`
|
|
Profiles that follow given user.
|
|
|
|
- :attr:`Post.owner_profile`, :attr:`Story.owner_profile` and :attr:`StoryItem.owner_profile`
|
|
Owner profile of particular object.
|
|
|
|
- :meth:`Post.get_likes`
|
|
Profiles that liked a given :class:`Post`
|
|
|
|
- :attr:`PostComment.owner` attribute for comment in :meth:`Post.get_comments`
|
|
Profile of a Post comment.
|
|
|
|
A reference of the many methods provided by the :mod:`instaloader` module is
|
|
provided in the remainder of this document.
|
|
|
|
``Instaloader`` (Main Class)
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: Instaloader
|
|
:no-show-inheritance:
|
|
|
|
Instagram Structures
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Posts
|
|
"""""
|
|
|
|
.. autoclass:: Post
|
|
:no-show-inheritance:
|
|
|
|
Additionally, the following trivial structures are defined:
|
|
|
|
.. autoclass:: PostSidecarNode
|
|
:no-show-inheritance:
|
|
:no-members:
|
|
|
|
.. autoclass:: PostComment
|
|
:no-show-inheritance:
|
|
:no-members:
|
|
|
|
.. autoclass:: PostLocation
|
|
:no-show-inheritance:
|
|
:no-members:
|
|
|
|
User Stories
|
|
""""""""""""
|
|
|
|
.. autoclass:: Story
|
|
:no-show-inheritance:
|
|
|
|
.. autoclass:: StoryItem
|
|
:no-show-inheritance:
|
|
|
|
Profiles
|
|
""""""""
|
|
|
|
.. autoclass:: Profile
|
|
:no-show-inheritance:
|
|
|
|
Loading and Saving
|
|
""""""""""""""""""
|
|
|
|
:class:`Post`, :class:`StoryItem` and :class:`Profile` can be saved and loaded
|
|
to/from JSON files.
|
|
|
|
.. autofunction:: load_structure_from_file
|
|
|
|
.. autofunction:: save_structure_to_file
|
|
|
|
Exceptions
|
|
^^^^^^^^^^
|
|
|
|
.. autoexception:: InstaloaderException
|
|
:no-show-inheritance:
|
|
|
|
.. autoexception:: QueryReturnedBadRequestException
|
|
|
|
.. autoexception:: QueryReturnedNotFoundException
|
|
|
|
.. autoexception:: QueryReturnedForbiddenException
|
|
|
|
.. autoexception:: ProfileNotExistsException
|
|
|
|
.. autoexception:: ProfileHasNoPicsException
|
|
|
|
.. autoexception:: PrivateProfileNotFollowedException
|
|
|
|
.. autoexception:: LoginRequiredException
|
|
|
|
.. autoexception:: InvalidArgumentException
|
|
|
|
.. autoexception:: BadResponseException
|
|
|
|
.. autoexception:: BadCredentialsException
|
|
|
|
.. autoexception:: ConnectionException
|
|
|
|
.. autoexception:: TooManyRequestsException
|
|
|
|
``InstaloaderContext`` (Low-level functions)
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: InstaloaderContext
|
|
:no-show-inheritance:
|