The Social Media API is a wrapper SDK for Ayrshare's APIs.
Ayrshare is a powerful set of APIs that enable you to send social media posts, get analytics, and manage comments to X/Twitter, Instagram, Facebook, LinkedIn, YouTube, Google Busienss Profile, Pinterest, TikTok, Reddit, and Telegram on behalf of your users or clients.
The Ayrshare Social API handles all the setup and maintenance for the social media networks. One API to rule them all (yeah, went there). See the full list of full list of features.
Get started with a free plan, or if you have a platform or manage multiple users check out the Business Plan.
For more information on setup, see our installation video or our Quick Start Guide.
pip install social-post-api
1. Create a free Ayrshare account.
2. Enable your social media accounts such as C/Twitter, Facebook, LinkedIn, Reddit, Instagram, Google Business Profile, Telegram, TikTok, or YouTube in the Ayrshare dashboard.
3. Copy your API Key from the Ayrshare dashboard. Used for authentication.
Create a new Social Post object with your API Key.
from ayrshare import SocialPost
social = SocialPost('DJED-DKEP-SJWK-WJKS') # get an API Key at ayrshare.comThis simple example shows how to post, get history, and delete the post. This example assumes you have a free API key from Ayrshare and have enabled X/Twitter, Facebook, and LinkedIn. Note, Instagram, Telegram, YouTube, TikTok, and Reddit also available.
from ayrshare import SocialPost
social = SocialPost('8jKj782Aw8910dCN') # get an API Key at ayrshare.com
# Post to Platforms Twitter, Facebook, and LinkedIn
postResult = social.post({'post': 'Nice Posting 2', 'platforms': ['twitter', 'facebook', 'linkedin']})
print(postResult)
# Delete
deleteResult = social.delete({'id': postResult['id']})
print(deleteResult)
# History
print(social.history())Published a new post to the specified social networks either immediately or at scheduled future date with the Social API. Returns a promise that resolves to an object containing the post ID and post status (success, error). See the post endpoint for the full capabilities.
postResponse = social.post({
# Required
'post': 'Best post ever!',
# Required: Social media platforms to post.
# Accepts an array of strings with values: "facebook", "twitter", "linkedin", "pinterest", "reddit", or "telegram".
'platforms': ['twitter', 'facebook', 'linkedin', 'pinterest', 'telegram', 'instagram'],
# Optional: URLs of images to include in the post or for Instagram
'mediaUrls': ['https://img.ayrshare.com/012/gb.jpg'],
# Optional: Datetime to schedule a future post.
# Accepts an ISO-8601 UTC date time in format "YYYY-MM-DDThh:mm:ssZ". Example: 2021-07-08T12:30:00Z
'scheduleDate': '2020-08-07T15:17:00Z',
# Optional: Shorten links in the post for all platforms similar to bit.ly.
# Only URLS starting with http or https will be shortened. Default value: true.
'shorten_links': true
})Delete a post with a given post ID, obtained from the "post" response. Returns a promise with the delete status. Also, can bulk delete multiple IDs at once using the "bulk" key. See the delete endpoint for more details.
deleteResponse = social.delete({
# Required
'id': 'POST ID', # Optional, but required if "bulk" not present
'bulk': ['Post ID 1', 'Post ID 2', ...] # Optional, but required if "id" not present
})Get a post with a given post ID. Returns a promise that resolves to a post object. See the get post endpoint for more details.
getResponse = social.getPost({
# Required
'id': 'POST ID',
})Retry a failed post with a given post ID. Returns a promise that resolves to an object with the post status. See the retry post endpoint for more details.
retryResponse = social.retryPost({
# Required
'id': 'POST ID',
})Update a post with a given post ID. Returns a promise that resolves to an object with status and update info. See the update post endpoint for more details.
updateResponse = social.updatePost({
'id': 'POST ID', # Required: ID of the post to update
'scheduleDate': '2024-08-07T15:17:00Z', # Optional: Datetime to schedule a future post.
'approved': 'true', # Optional: Approve the post to send it.
'youTubeOptions': { # Optional: YouTube specific options
'title': 'New Title',
'description': 'New Description',
'visibility': 'unlisted',
'categoryId': 24,
},
'notes': 'New notes', # optional: Notes about the post
})Get a history of all posts and their current status in descending order. Returns a promise that resolves to an array of post objects. See the history endpoint for more details.
historyResponse = social.history({
'lastRecords': 10, # optional: returns the last X number of history records
'lastDays': 30, # optional: returns the last X number of days of history records. Defaults to 30 if not present.
})Upload and store a new image. Returns a URL referencing the image. Can be used in "image_url" in "post". See the media endpoint for more details.
uploadResponse = social.upload({
# Required: The image as a Base64 encoded string. Example encoding: https://www.base64-image.de/
'file': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...',
# Optional
'fileName': 'test.png',
# Optional
'description': 'best image'
})Get all media URLS. Returns a promise that resolves to an array of URL objects. See the media endpoint for more details.
mediaResponse = social.media()Verify that the media file exists when uploaded. See the media verify exists endpoint for more details.
verifyResponse = social.verifyMediaExists({
# Required: URL of the media file
'mediaUrl': 'https://img.ayrshare.com/012/gb.jpg',
})Get image resized according to social network requirements. See the resize image endpoint for more details.
resizeResponse = social.resizeImage({
'imageUrl': "https://theImage.jpg", # required: URL of the image to resize
'platform': "facebook" # required: Platform to resize the image for.
'watermarkUrl': "https:#theWatermark.png", # optional: URL of the watermark image to add to the image.
'effects': { color: "#A020F0" } # optional: Change opacity, colors, etc. See endpoint for more details.
'dimensions': { width: 1200, height: 628 } # optional: Width and height of the image. Required if platform is not specified.
'mode': "blur" # optional. See endpoint for more details.
})Get data about the logged in user, such as post quota, used quota, active social networks, and created date. See the user endpoint for more details.
user = social.user()Shorten a URL and return the shortened URL. See the shorten endpoint for more details.
shortenResponse = social.shorten({
# Required: URL to shorten
'url': 'https://theURLtoShorten.com/whatmore',
})Get analytics on shortened links and shares, likes, shares, and impressions with for a post or at the accounts level. See the analytics endpoint for more details.
analytics = social.analyticsLinks({
# Optional range 1-7, default 1 day.
'lastDays': 3
})analytics = social.analyticsPost({
'id': 'Post ID',
'platforms': ['twitter', 'linkedin'] # optional: filter by platform
})analytics = social.analyticsSocial({
'platforms': ['twitter', 'linkedin'] # required
})Add a new RSS or Substack feed to auto post all new articles. Returns a promise that resolved to an object containing the feed ID. See How to Automate Your Blog or Newsletter for more info.
feedResponse = social.addFeed({
# Required: URL to shorten
'url': 'https://theRSSFeed',
# Optional: Value: "rss" or "substack".
# If not set, defaults to "rss"
'type': 'RSS',
})Delete an RSS feed for a given ID.
feedResponse = social.deleteFeed({
# Required: ID of the feed
'id': 'Feed ID',
})Get all registered RSS feeds. Returns a promise that resolves to an array of feed objects. See the get feeds endpoint for more details.
feedsResponse = social.getFeeds()Update an RSS feed for a given ID. Returns a promise that resolves to an object containing the feed ID. See the update feed endpoint for more details.
feedResponse = social.updateFeed({
'id': 'Feed ID', # required: ID of the feed
'useFirstImage': 'true', # optional: Use the first image in the article to add to the post.
'autoHashtag': 'true', # optional: Automatically add hashtags to the post.
})Get comments for a post. Currently only on Facebook and Instagram. See the get comment endpoint for more details.
getCommentsResponse = social.getComments({
# Required: ID of the Post
'id': 'Post Id',
})Add a comment to a post. Currently only on Facebook and Instagram. See the create comment endpoint for more details.
postCommentResponse = social.postComment({
# Required: ID of the Post
'id': 'Post Id',
'platforms': ['facebook', 'instagram'],
'comment': 'The best comment ever!',
})Delete either a single comment or all comments under a post that were sent via Ayrshare. Available for Facebook, Instagram, LinkedIn, Reddit, TikTok, X/Twitter, and YouTube. See the delete comments endpoint for more details.
deleteCommentResponse = social.deleteComments({
'id': "Pkdo9sjk2", # required: Post top-level ID or social comment ID
'platforms': ["instagram", "facebook"], # optional: Required only if using the social comment id.
})Reply to a comment. Available for Facebook, Instagram, LinkedIn, TikTok, X/Twitter, and YouTube. See the reply comment endpoint for more details.
replyCommentResponse = social.replyComment({
'commentId': 'Pkdo9sjk2', # required: The Ayrshare commentId returned from the POST comment endpoint. Be sure to use the top level commentId.
'platforms': ['instagram', 'facebook'], # required: Array of platforms to post the reply. Values: facebook, instagram, linkedin, tiktok, twitter, youtube
'comment': 'What a comment' # required: The reply to add to the comment.
})The Business Plan allows you to create, manage, and post on behalf of client profiles via the API or Dashboard GUI. You can integrate Ayrshare into your platform, product, or agency and give your clients social media capabilites. Please contact us with any questions.
Create a new account profile under the primary account. See the create profile endpoint for more details.
createProfileResponse = social.createProfile({
# Required: title
'title': 'New Profile Title',
})Delete a profile owned by the primary account. See the delete profile endpoint for more details.
deleteProfileResponse = social.deleteProfile({
# Required: profileKey - the API Key of the profile to delete
'profileKey': 'JI9s-kJII-9283-OMKM',
})Generate a JWT Token and URL used for authorizing a user's access to the Social Account linking page. See the generate JWT endpoint for more details.
generateJWTResponse = social.generateJWT({
'domain': 'mydomin',
'privateKey': 'private key data...',
'profileKey': 'JI9s-kJII-9283-OMKM',
})Update a profile owned by the primary account. See the update profile endpoint for more details.
updateProfileResponse = social.updateProfile({
'profileKey': 'JI9s-kJII-9283-OMKM', #Required: profileKey - the API Key of the profile to update
'title': 'This is a great new title' #Optional: the new title of the profile
'disableSocial': ['facebook', 'linkedin'] #Optional: an array of social networks to disable
'hideTitle': 'true' #Optional: hide the title of the profile
'displayTitle': 'true' #Optional: display the title of the profile
})Get all the profiles associated with the primary account. See the get profile endpoint for more details.
getProfileResponse = social.getProfiles()Unlink a social account for a given user profile owned by the primary account. See the unlink social network endpoint for more details.
unlinkResponse = social.unlinkSocial({
'profileKey': "JI9s-kJII-9283-OMKM", # Required: profileKey - the API Key of the profile to unlink for.
'platform': "facebook"
})Get brand information on users and companies public social media accounts. See the brand endpoint for more details.
brandResponse = social.getBrandByUser({
'platforms': ['instagram', 'facebook'],
'instagramUser': '@ayrshare',
'facebookUser': 'ayrshare',
})Automatically add hashtags to your post. See the auto hashtags endpoint for more details.
autoHashtagsResponse = social.autoHashtags({
'post': 'I love social media', # required: Post text to add hashtags for.
'position': 'auto' # optional: Position of the hashtags. Values: 'auto', 'end'. Default: 'auto'.
'max': 2 # optional: Maximum number of hashtags to add, ranging 1-5. Default: 2.
})Get suggestions for hashtags based on a keyword. See the recommend hashtags endpoint for more details.
recommendHashtagsResponse = social.recommendHashtags({
'keyword': 'social media', # required: Keyword to get hashtags for.
})Check if a hashtag is banned on Instagram or other social networks. See the check banned hashtags endpoint for more details.
checkBannedHashtagsResponse = social.checkBannedHashtags({
'hashtag': 'socialmedia', # required: Hashtag to check.
})Retrieve all the reviews for the specified platform. See the get all reviews endpoint for more details.
allReviewsResponse = social.reviews({
'platform': 'facebook', # required: Platform to get reviews for. Currently available: "facebook", "gmb"
})Retrieve a single review. See the get single review endpoint for more details.
singleReviewResponse = social.review({
'id': 'Review ID', # required
'platform': 'gmb', # required: Platform to get review for. Currently available: "gmb"
})Reply to a review. See the reply to review endpoint for more details.
replyReviewResponse = social.replyReview({
'reviewId': 'Review ID', # required: Review ID to reply to.
'platform': 'facebook', # required: Platform to reply to review for. Currently available: "facebook", "gmb"
'reply': 'Thank you for the review' # required: Text of the reply to the review.
})Delete a review reply. See the delete review reply endpoint for more details.
deleteReplyReviewResponse = social.deleteReplyReview({
'reviewId': 'Review ID', # required: Review ID to delete reply for.
'platform': 'gmb', # required: Platform to delete reply for. Currently available: "gmb"
})Generate a new social post using ChatGPT. Token limits applicable. See the generate post endpoint for more details.
generatePostResponse = social.generatePost({
'text': 'I love social media', # required: Description of what the post should be about.
'hashtags': 'true', #optional: Include hashtags in the post. Default: true
'emojis': 'true', # optional: Include emojis in the post. Default: false
'twitter': 'true', # optional: Construct a post 280 or few characters. Default: false
})Generate variations of a social media post using ChatGPT. Token limits applicable. See the generate rewrite endpoint for more details.
generateRewriteResponse = social.generateRewrite({
'post': 'I love social media', # required: The post text to be rewritten.
'emojis': 'true', # optional: Include emojis in the post. Default: false
'hashtags': 'true', # optional: Include hashtags in the post. Default: false
'twitter': 'true', # optional: Construct a post 280 or few characters. Default: false
'rewrites': 5, # optional: Number of rewrites to generate. Default: 5
})Provide a transcription of a video file. See the generate transcription endpoint for more details.
generateTranscriptionResponse = social.generateTranscription({
'videoUrl': 'https://theVideo.mp4', # required: URL encoded video URL. The video must be hosted by Ayrshare.
})Translate text for a post to over 100 different languages. See the generate translation endpoint for more details.
generateTranslationResponse = social.generateTranslation({
'text': 'I love social media', # required: The text to be translated.
'lang': 'es', # required: The language code to translate the text to.
})Create AI-generated alt text for your images. See the generate alt text endpoint for more details.
generateAltTextResponse = social.generateAltText({
'url': 'https://theImage.jpg', # required: URL of the image to generate alt text for.
'keywords': ['social media', 'ayrshare'], # optional: Keywords to help the AI generate better alt text.
'lang': 'en' # optional: The language code to generate the alt text in. Default: 'en'
})Provide a URL and a shortened link will be returned. See the shorten link endpoint for more details.
shortenLinkResponse = social.shortLink({
'url': 'https://theURL.com', # required: URL to shorten.
'utmId': '1234', # optional: UTM ID to track the link. See more details about utm parameters at endpoint link above.
'utmSource': 'source', # optional
'utmMedium': 'medium', # optional
'utmCampaign': 'campaign', # optional
'utmTerm': 'term', # optional
'utmContent': 'content', # optional
})Return analytics for all shortened links or a single link for a given link ID. See the analytics link endpoint for more details.
analyticsLinkResponse = social.shortLinkAnalytics({
'id': 'Link ID', # optional: Link ID to get analytics for.
'fromCreatedDate': '2023-07-08T12:30:00Z', # optional: Get history of links shortened after this date.
'toCreatedDate': '2023-07-08T12:30:00Z', # optional: Get history of links shortened before this date.
'fromClickDate': '2023-07-08T12:30:00Z', # optional: Get history of links clicked after this date.
'toClickDate': '2023-07-08T12:30:00Z', # optional: Get history of links clicked before this date.
})- Webhooks endpoints
- unregisterWebhook
- listWebhook
- setAutoSchedule
- deleteAutoSchedule
- listAutoSchedule
We have other package and integrations such as Node NPM, Bubble.io, and Airtable + examples in C#, PHP, and Go.
Additional examples, responses, etc. can be found at:
See our changelog for the latest and greatest.
Please contact us with your questions, or just to give us shout-out 📢!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent