Skip to content

Usage

Once you have access token with permissions. Let us do something for the data.

Initial API by access token

from pinterest import Api
p = Api(access_token="Your access token")
Async mode 
from pinterest import AsyncApi

ap = AsyncApi(access_token="Your access token")

User Accounts

p.user_account.get()
# UserAccount(username='merleliukun', account_type='BUSINESS')
Async mode 
await ap.user_account.get()
# UserAccount(username='merleliukun', account_type='BUSINESS')

boards

# list my boards
p.boards.list()
# BoardsResponse(items=[Board(id='1022106146619699845', name='City'), Board(id='1022106146619703648', name='Food')], bookmark=None)
# list my board's pins
p.boards.list_pins(board_id="1022106146619699845")
# PinsResponse(items=[Pin(id='1022106077902810180', created_at='2022-02-14T02:54:38'), Pin(id='1022106077902781601', created_at='2022-02-13T11:29:51'), Pin(id='1022106077902781616', created_at='2022-02-13T11:31:07'), Pin(id='1022106077902203823', created_at='2021-12-29T02:24:55')], bookmark=None)
Async mode 
# list my boards
await ap.boards.list()
# BoardsResponse(items=[Board(id='1022106146619699845', name='City'), Board(id='1022106146619703648', name='Food')], bookmark=None)
# list my board's pins
await ap.boards.list_pins(board_id="1022106146619699845")
# PinsResponse(items=[Pin(id='1022106077902810180', created_at='2022-02-14T02:54:38'), Pin(id='1022106077902781601', created_at='2022-02-13T11:29:51'), Pin(id='1022106077902781616', created_at='2022-02-13T11:31:07'), Pin(id='1022106077902203823', created_at='2021-12-29T02:24:55')], bookmark=None)

pins

# Get pin data
p.pins.get(pin_id="1022106077902810180")
# Pin(id='1022106077902810180', created_at='2022-02-14T02:54:38')
# Get pin analytics
p.pins.get_analytics(pin_id="1022106077902810180", start_date="2022-02-10", end_date="2022-02-11",metric_types="IMPRESSION")
# Analytics(all=AnalyticsAll(daily_metrics=[DailyMetric(date='2022-02-10'), DailyMetric(date='2022-02-11')]))
Async mode 
# Get pin data
await ap.pins.get(pin_id="1022106077902810180")
# Pin(id='1022106077902810180', created_at='2022-02-14T02:54:38')
# Get pin analytics
await ap.pins.get_analytics(pin_id="1022106077902810180", start_date="2022-02-10", end_date="2022-02-11",metric_types="IMPRESSION")
# Analytics(all=AnalyticsAll(daily_metrics=[DailyMetric(date='2022-02-10'), DailyMetric(date='2022-02-11')]))

And other apis are same as above.