Project

Namespaces

Public Vars

clj-instagram.endpoints

Functions for accessing Instagram endpoints. The API requires access from authenticated users for each endpoint.
Functions in this namespace are using corresponding functions from `clj-instagram.requests` namespace.

They require one additional map parameter with the following possible keys:

  :access-token     - a valid access token
  :client-secret    - client secret for encoding the request (optional)
  :sign-request?    - sign requests (optional, default: true)
  :http-client-opts - map of HTTP client options (optional)

For more details about available HTTP client options: https://github.com/dakrone/clj-http

For more details about the API refer to official documentation: https://www.instagram.com/developer/endpoints/

create-comment

(create-comment media-id text opts)
Create a comment on a media object with the following rules:

* The total length of the comment cannot exceed 300 characters
* The comment cannot contain more than 4 hashtags
* The comment cannot contain more than 1 URL
* The comment cannot consist of all capital letters

Parameters:
  media-id - media id
  text     - comment text
  opts     - map of endpoint call options
view source

delete-comment

(delete-comment media-id comment-id opts)
view source
get-comments
(get-comments media-id opts)
Get a list of recent comments on a media object.

Parameters:
  media-id - media id
  opts     - map of endpoint call options
view source
get-followed-by
(get-followed-by opts)
Get the list of users this user is followed by.

Parameters:
  opts - map of endpoint call options
view source
get-follows
(get-follows opts)
Get the list of users this user follows.

Parameters:
  opts - map of endpoint call options
view source
get-liked-media
(get-liked-media opts)(get-liked-media optional-params opts)
Get the list of recent media liked by the owner of the access token.

Parameters:
  count       - count of media to return (optional)
  max-like-id - return media liked before this id (optional)
  opts        - map of endpoint call options
view source
get-likes
(get-likes media-id opts)
Get a list of users who have liked this media.

Parameters:
  media-id - media id
  opts     - map of endpoint call options
view source
get-location
(get-location location-id opts)
Get information about a location.

Parameters:
  location-id - location id
  opts        - map of endpoint call options
view source
get-media-by-id
(get-media-by-id media-id opts)
Get information about a media object. Use the :type field to differentiate between image and video media in the
response. You will also receive the :user_has_liked field which tells you whether the owner of the access token has
liked this media.

Parameters:
  media-id - media id
  opts     - map of endpoint call options
view source
get-media-by-shortcode
(get-media-by-shortcode shortcode opts)
Get information about a media object. Use the :type field to differentiate between image and video media in the
response. You will also receive the :user_has_liked field which tells you whether the owner of the access token has
liked this media. A media object's shortcode can be found in its shortlink URL. An example shortlink is
http://instagram.com/p/tsxp1hhQTG/. Its corresponding shortcode is tsxp1hhQTG.

Parameters:
  shortcode - media object's shortcode
  opts      - map of endpoint call options
view source
get-recent-media-by-me
(get-recent-media-by-me opts)(get-recent-media-by-me optional-params opts)
Get the most recent media published by the owner of the access token.

Parameters:
  count   - count of media to return (optional)
  min-id  - Return media later than this min id (optional)
  max-id  - Return media earlier than this max id (optional)
  opts    - map of endpoint call options
view source
get-recent-media-by-user
(get-recent-media-by-user user-id opts)(get-recent-media-by-user user-id optional-params opts)
Get the most recent media published by a user.

Parameters:
  user-id - user id
  count   - count of media to return (optional)
  min-id  - return media later than this min id (optional)
  max-id  - return media earlier than this max id (optional)
  opts    - map of endpoint call options
view source
get-recent-media-from-location
(get-recent-media-from-location location-id opts)(get-recent-media-from-location location-id {:keys [min-id max-id], :as optional-params} opts)
Get a list of recent media objects from a given location.

Parameters:
  location-id - location id
  min-id      - return media before this min id (optional)
  max-id      - return media after this max id (optional)
  opts        - map of endpoint call options
view source
get-recently-tagged-media
(get-recently-tagged-media tag opts)(get-recently-tagged-media tag {:keys [count min-tag-id max-tag-id], :as optional-params} opts)
Get a list of recently tagged media.

Parameters:
  tag        - tag name
  count      - count of tagged media to return (optional)
  min-tag-id - return media before this min tag id (optional)
  max-tag-id - return media after this max tag id (optional)
  opts       - map of endpoint call options
view source
get-relationship
(get-relationship user-id opts)
Get information about a relationship to another user. Relationships are expressed using the following terms in the
response:

* outgoing_status: Your relationship to the user. Can be 'follows', 'requested', 'none'
* incoming_status: A user's relationship to you. Can be 'followed_by', 'requested_by', 'blocked_by_you', 'none'

Parameters:
  user-id - user id
  opts    - map of endpoint call options
view source
get-requested-by
(get-requested-by opts)
List the users who have requested this user's permission to follow.

Parameters:
  opts - map of endpoint call options
view source
get-tag
(get-tag tag opts)
Get information about a tag object.

Parameters:
  tag  - tag
  opts - map of endpoint call options
view source
get-user
(get-user opts)(get-user user-id opts)
Get information about a user. If user id is omitted returns information about the owner of the access token.

Parameters:
  user-id - user id (default: owner of the access token)
  opts    - map of endpoint call options
view source
modify-relationship
(modify-relationship user-id action opts)
Modify the relationship between the current user and the target user. Relationships are expressed using the following
terms in the response:

* outgoing_status: Your relationship to the user. Can be 'follows', 'requested', 'none'
* incoming_status: A user's relationship to you. Can be 'followed_by', 'requested_by', 'blocked_by_you', 'none'

Parameters:
  user-id - user id
  action  - action to perform: :follow, :unfollow, :approve or :ignore
  opts    - map of endpoint call options
view source
remove-like
(remove-like media-id opts)
Remove a like on this media by the currently authenticated user.

Parameters:
  media-id - media id
  opts     - map of endpoint call options
view source
search-locations
(search-locations {:keys [facebook-places-id lat lng distance], :as search-params} opts)
Search for a location by geographic coordinate or Facebook Places ID.

Parameters:
  facebook-places-id - returns a location mapped off of a Facebook places id.
                       (optional, if used, lat and lng are not required)
  lat                - latitude of the center search coordinate (optional, if used, lng is required)
  lng                - longitude of the center search coordinate (optional, if used, lat is required)
  distance           - distance in meters (optional, default 1000, max 5000)
  opts               - map of endpoint call options
view source
search-media
(search-media lat lng opts)(search-media lat lng distance opts)
Search for recent media in a given area.

Parameters:
  lat      - latitude of the center search coordinate
  lng      - longitude of the center search coordinate
  distance - distance in meters (optional, default 1000, max 5000)
  opts     - map of endpoint call options
view source
search-tags
(search-tags q opts)
Search for tags by name.

Parameters:
  q    - a valid tag name without a leading # (eg. snowy, nofilter)
  opts - map of endpoint call options
view source
search-users
(search-users q opts)(search-users q count opts)
Get a list of users matching the query.

Parameters:
  q     - a query string
  count - number of users to return (optional)
  opts  - map of endpoint call options
view source
set-like
(set-like media-id opts)
Set a like on this media by the currently authenticated user.

Parameters:
  media-id - media id
  opts     - map of endpoint call options
view source