Skip to content

Commit 58ac8bb

Browse files
committed
Add API.get_profile_banner
1 parent 6ce4d90 commit 58ac8bb

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

docs/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,8 @@ Manage account settings and profile
152152

153153
.. automethod:: API.get_saved_search
154154

155+
.. automethod:: API.get_profile_banner
156+
155157

156158
Direct Message Methods
157159
----------------------

tweepy/api.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1804,6 +1804,30 @@ def get_saved_search(self, id, **kwargs):
18041804
"""
18051805
return self.request('GET', f'saved_searches/show/{id}', **kwargs)
18061806

1807+
@payload('json')
1808+
def get_profile_banner(self, **kwargs):
1809+
"""get_profile_banner(*, user_id, screen_name)
1810+
1811+
Returns a map of the available size variations of the specified user's
1812+
profile banner. If the user has not uploaded a profile banner, a HTTP
1813+
404 will be served instead.
1814+
1815+
The profile banner data available at each size variant's URL is in PNG
1816+
format.
1817+
1818+
:param user_id: |user_id|
1819+
:param screen_name: |screen_name|
1820+
1821+
:rtype: :class:`JSON` object
1822+
1823+
:reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner
1824+
"""
1825+
return self.request(
1826+
'GET', 'users/profile_banner', endpoint_parameters=(
1827+
'user_id', 'screen_name'
1828+
), **kwargs
1829+
)
1830+
18071831
def media_upload(self, filename, *, file=None, chunked=False,
18081832
media_category=None, additional_owners=None, **kwargs):
18091833
""" :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview

0 commit comments

Comments
 (0)