pinterex v0.2.1 Pinterex

This is the main module of the libray. Use it to access all of the available Pinterest API calls.

Summary

Functions

Creates a Board with the specified name for the authenticated User

Creates a Board with the specified name for the authenticated User

Deletes the specified Board for the authenticated User

Delete the specified Pin for the authenticated User

Edit the specified Board for the authenticated User

Follow the specified Board as the authenticated User

Returns the Board information

Returns the Board information

Returns a list of Pins from the specified Board

Returns a list of Pins from the specified Board

Returns the information of the requested Pin

Returns the information of the requested Pin

Used for fetching the data of the authenticated User’s profile

Used for fetching the data of the authenticated User’s profile

Returns a list of the public Boards of the authenticated User

Returns a list of the public Boards of the authenticated User

Returns the Users that follow the authenticated User

Returns the Users that follow the authenticated User

Returns a list of Boards that the authenticated User follows

Returns a list of Boards that the authenticated User follows

Returns a list of Interests that the authenticated User follows

Returns the Users that the authenticated User follows

Returns the Users that the authenticated User follows

Returns a list of Pins that the authenticated User liked

Returns a list of Pins that the authenticated User liked

Returns a list of Pins that the authenticated User pinned

Returns a list of Pins that the authenticated User pinned

Returns a list of Boards that Pinterest would suggest to the authenticated User if they were to save the specified Pin

Returns a list of Boards that Pinterest would suggest to the authenticated User if they were to save the specified Pin

Returns a list of the authenticated User’s Boards that match the search query

Returns a list of the authenticated User’s Boards that match the search query

Returns a list of the authenticated User’s Pins that match the search query

Returns a list of the authenticated User’s Pins that match the search query

Unfollow the specified Board as the authenticated User

Functions

create_board(name)

Creates a Board with the specified name for the authenticated User.

Reference

By default the API returns the ID, URL and name of the created Board.

https://developers.pinterest.com/docs/api/boards/

Parameters

  • name: the name of the Board you wish to create (required)
create_board(name, description)

Creates a Board with the specified name for the authenticated User.

Reference

By default the API returns the ID, URL and name of the created Board.

https://developers.pinterest.com/docs/api/boards/

Parameters

  • name: the name of the Board you wish to create (required)
  • description: the description of the Board you wish to create (optional)
delete_board(board)

Deletes the specified Board for the authenticated User.

Reference

https://developers.pinterest.com/docs/api/boards/

Parameters

  • board: The board you want to delete. The format of the parameters should be “username/board_name” (required)
delete_pin(pin)

Delete the specified Pin for the authenticated User.

Reference

https://developers.pinterest.com/docs/api/pins/

Parameters

  • pin: the id of the Pin you wish to delete (required)
edit_board(board, options)

Edit the specified Board for the authenticated User.

Reference

By default the API returns the ID, URL, and name of the edited Board.

https://developers.pinterest.com/docs/api/boards/

Parameters

  • board: the id of the Board you wish to edit. The format of the parameters should be “username/board_name” (required)
  • options: you can specify a new name and / or a new descriptions.

Example

Pinterex.edit_board("username/board_name", [name: "New name"])

Pinterex.edit_board("username/board_name", [name: "New name", description: "New description"])

follow_board(board)

Follow the specified Board as the authenticated User.

Reference

https://developers.pinterest.com/docs/api/users/

Parameters

  • board: the Board to follow. The format of the parameters should be “username/board_name”
get_board(board)

Returns the Board information.

Reference

By default the API returns the ID, URL and the name of the specified Board. Use Pinterex.get_board/2 to get other fields.

https://developers.pinterest.com/docs/api/boards/

Parameters

  • board: the id of the Board whose info you wish to get. The format of the parameter should be “username/board_name” (required)
get_board(board, options)

Returns the Board information.

Reference

By default the API returns the ID, URL and the name of the specified Board.

https://developers.pinterest.com/docs/api/boards/

Parameters

  • board: the id of the Board whose info you wish to get. The format of the parameter should be “username/board_name” (required)
  • options: if we wish to get other fields of the Board we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Board.

Example

Pinterex.get_board("username/board_name", [fields: ["image", "counts"]])

get_board_pins(board)

Returns a list of Pins from the specified Board.

Reference

By default the API returns the IDs, URLs, links and descriptions of the Pins. Use Pinterex.get_board_pins/2 to get other fields.

https://developers.pinterest.com/docs/api/boards/

Parameters

  • board: the id of the Board whose pins you wish to get. The format of the parameters should be “username/board_name” (required)
get_board_pins(board, options)

Returns a list of Pins from the specified Board.

Reference

By default the API returns the IDs, URLs, links and descriptions of the Pins.

https://developers.pinterest.com/docs/api/boards/

Parameters

  • board: the id of the Board whose pins you wish to get. The format of the parameters should be “username/board_name” (required)
  • options: if we wish to get other fields of the Pins we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Pin.

Example

Pinterex.get_board_pins("username/board_name", [fields: ["note", "counts']])

Pinterex.get_board_pins("username/board_name", [fields: ["note", "counts'], limit: 50])

get_pin(id)

Returns the information of the requested Pin.

Reference

By default the API returns the ID, URL, link and the description of the Pin. Use Pinterex.get_pin/2 to get other fields.

https://developers.pinterest.com/docs/api/pins/

Parameters

  • id: the id of the Pin
get_pin(id, options)

Returns the information of the requested Pin.

Reference

By default the API returns the ID, URL, link and the description of the Pin.

https://developers.pinterest.com/docs/api/pins/

Parameters

  • id: the id of the Pin
  • options: if we wish to get other fields of the Pin we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Pin

Example

Pinterex.get_pin("123456", [fields: ["note", "counts"]])

me()

Used for fetching the data of the authenticated User’s profile.

Reference

By default the API returns first and last name, ID and URL of the authenticated User. Use Pinterex.me/1 if you wish to get other fields.

https://developers.pinterest.com/docs/api/users/

me(options)

Used for fetching the data of the authenticated User’s profile.

Reference

By default the API returns first and last name, ID and URL of the authenticated User.

https://developers.pinterest.com/docs/api/users/

Parameters

  • options: if we wish to get other fields of the User we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.User.

Example

Pinterex.me([fields: ["bio", "counts"]])

my_boards()

Returns a list of the public Boards of the authenticated User.

Reference

By default the API returns their URLs, IDs and names. Use Pinterex.my_boards/1 to get other fields.

https://developers.pinterest.com/docs/api/users/

my_boards(options)

Returns a list of the public Boards of the authenticated User.

Reference

By default the API returns their URLs, IDs and names.

https://developers.pinterest.com/docs/api/users/

Parameters

  • options: if we wish to get other fields of the Boards we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Board.

Example

Pinterex.my_boards([fields: ["image", "counts"]])

Pinterex.my_boards([fields: ["image", "counts"], limit: 50])

my_followers()

Returns the Users that follow the authenticated User.

Reference

By default the API returns the first names, last names, IDs and URLs of the Users. Use Pinterex.my_followers/1 to get other fields.

https://developers.pinterest.com/docs/api/users/

my_followers(options)

Returns the Users that follow the authenticated User.

Reference

By default the API returns the first names, last names, IDs and URLs of the Users.

https://developers.pinterest.com/docs/api/users/

Parameters

  • options: if we wish to get other fields of the Users we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.User.

Example

Pinterex.my_followers([fields: ["bio", "counts"]])

Pinterex.my_followers([fields: ["bio", "counts"], limit: 50])

my_following_boards()

Returns a list of Boards that the authenticated User follows.

Reference

By default the API returns the IDs, URLs and names of the Boards. Use Pinterex.my_following_boards/1 to get other fields.

https://developers.pinterest.com/docs/api/users/

my_following_boards(options)

Returns a list of Boards that the authenticated User follows.

Reference

By default the API returns the IDs, URLs and names of the Boards.

https://developers.pinterest.com/docs/api/users/

Parameters

  • options: if we wish to get other fields of the Boards we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Board.

Example

Pinterex.my_following_boards([fields: ["image", "counts"]])

Pinterex.my_following_boards([fields: ["image", "counts"], limit: 50])

my_following_interests()

Returns a list of Interests that the authenticated User follows.

Reference

By default the API returns the IDs and names of the Interests.

https://developers.pinterest.com/docs/api/users/

my_following_users()

Returns the Users that the authenticated User follows.

Reference

By default the API returns the first names, last names, IDs and URLs of the Users. Use Pinterex.my_following_users/1 to get other fields.

https://developers.pinterest.com/docs/api/users/

my_following_users(options)

Returns the Users that the authenticated User follows.

Reference

By default the API returns the first names, last names, IDs and URLs of the Users.

https://developers.pinterest.com/docs/api/users/

Parameters

  • options: if we wish to get other fields of the Users we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.User.

Example

Pinterex.my_following_users([fields: ["bio", "counts"]])

Pinterex.my_following_users([fields: ["bio", "counts"], limit: 50])

my_likes()

Returns a list of Pins that the authenticated User liked.

Reference

By default the API returns the IDs, URLs, links and descriptions of the Pins. Use Pinterex.my_likes/1 to get other fields.

https://developers.pinterest.com/docs/api/users/

my_likes(options)

Returns a list of Pins that the authenticated User liked.

Reference

By default the API returns the IDs, URLs, links and descriptions of the Pins.

https://developers.pinterest.com/docs/api/users/

Parameters

  • options: if we wish to get other fields of the Pins we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Pin

Example

Pinterex.my_likes([fields: ["note", "counts"]])

Pinterex.my_likes([fields: ["note", "counts"], limit: 50])

my_pins()

Returns a list of Pins that the authenticated User pinned.

Reference

By default the API returns the IDs, URLs, links and descriptions of the User’s Pins. Use Pinterex.my_pins/1 to get other fields.

https://developers.pinterest.com/docs/api/users/

my_pins(options)

Returns a list of Pins that the authenticated User pinned.

Reference

By default the API returns the IDs, URLs, links and descriptions of the User’s Pins.

https://developers.pinterest.com/docs/api/users/

Parameters

  • options: if we wish to get other fields of the Pins we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Pin

Example

Pinterex.my_pins([fields: ["note", "counts"]])

Pinterex.my_pins([fields: ["note", "counts"], limit: 50])

my_suggested_boards(id)

Returns a list of Boards that Pinterest would suggest to the authenticated User if they were to save the specified Pin.

Reference

By default the API returns the IDs, URLs and names of the Boards. Use Pinterex.my_suggested_boards/2 to get other fields.

https://developers.pinterest.com/docs/api/users/

Parameters

  • id: the id of the Pin for which you wish to get the suggestions (required)
my_suggested_boards(id, options)

Returns a list of Boards that Pinterest would suggest to the authenticated User if they were to save the specified Pin.

Reference

By default the API returns the IDs, URLs and names of the Boards.

https://developers.pinterest.com/docs/api/users/

Parameters

  • id: the id of the Pin for which you wish to get the suggestions (required)
  • options: if we wish to get other fields of the suggested Boards we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Board.

Example

Pinterex.my_suggested_boards("1253434223", ["image", "counts"])

Pinterex.my_suggested_boards("1253434223", [fields: ["image", "counts"], limit: 5])

search_my_boards(query)

Returns a list of the authenticated User’s Boards that match the search query.

Reference

By default the API returns IDs, URLs and names of the matched Boards. Use Pinterex.search_my_boards/2 to get other fields.

https://developers.pinterest.com/docs/api/users/

Parameters

  • query: the query string you wish to search for (required)
search_my_boards(query, options)

Returns a list of the authenticated User’s Boards that match the search query.

Reference

By default the API returns IDs, URLs and names of the matched Boards.

https://developers.pinterest.com/docs/api/users/

Parameters

  • query: the query string you wish to search for (required)
  • options: if we wish to get other fields of the Boards we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Board.

Example

Pinterex.search_my_boards("garden", [fields: ["image', "counts"]])

Pinterex.search_my_boards("garden", [fields: ["image', "counts"], limit: 50])

search_my_pins(query)

Returns a list of the authenticated User’s Pins that match the search query.

Reference

By default the API returns IDs, URLs, links and descriptions of the matched Pins. Use Pinterex.search_my_pins/2 to get other fields.

https://developers.pinterest.com/docs/api/users/

Parameters

  • query: the query string you wish to search for (required)
search_my_pins(query, options)

Returns a list of the authenticated User’s Pins that match the search query.

Reference

By default the API returns IDs, URLs, links and descriptions of the matched Pins. Use Pinterex.searchMyPins/2 to get other fields.

https://developers.pinterest.com/docs/api/users/

Parameters

  • query: the query string you wish to search for (required)
  • options: if we wish to get other fields of the Pins we pass a list of fields to fetch. To see which fields are available look at Pinterex.Structs.Pin

Example

Pinterex.search_my_pins("garden", [fields: ["note", "counts"]])

Pinterex.search_my_pins("garden", [fields: ["note", "counts"], limit: 50])

unfollow_board(board)

Unfollow the specified Board as the authenticated User.

Reference

https://developers.pinterest.com/docs/api/users/

Parameters

  • board: the Board to unfollow. The format of the parameters should be “username/board_name”