Social Media APIs for Posting, Scheduling, and Analytics
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 add comments to Twitter, Instagram, Facebook, LinkedIn, YouTube, Google My Business, 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.
Installation
pip install social-post-api
Setup
1. Create a free Ayrshare account.
![alt Social Accounts Setup](https://www.ayrshare.com/wp-content/uploads/2021/07/ayrshare-login.jpg)
2. Enable your social media accounts such as Twitter, Facebook, LinkedIn, Reddit, Instagram, Google My Business, Telegram, TikTok, or YouTube in the Ayrshare dashboard.
![alt Social Accounts Setup](https://www.ayrshare.com/wp-content/uploads/social-api-linking.jpg)
3. Copy your API Key from the Ayrshare dashboard. Used for authentication.
![alt API Key](https://www.ayrshare.com/wp-content/uploads/social-api-key.jpg)
Getting Started
Initialize Social Media API
Create a new Social Post object with your API Key.
from ayrshare import SocialPost
social = SocialPost('8jKj782Aw8910dCN')
History, Post, Delete Example
This 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 Twitter, Facebook, and LinkedIn. Note, Instagram, Telegram, YouTube, and Reddit also available.
from ayrshare import SocialPost
social = SocialPost('8jKj782Aw8910dCN')
postResult = social.post({'post': 'Nice Posting 2', 'platforms': ['twitter', 'facebook', 'linkedin']})
print(postResult)
deleteResult = social.delete({'id': postResult['id']})
print(deleteResult)
print(social.history())
Social API
Post
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({
'post': 'Best post ever!',
'platforms': ['twitter', 'facebook', 'linkedin', 'pinterest', 'telegram', 'instagram'],
'mediaUrls': ['https://img.ayrshare.com/012/gb.jpg'],
'scheduleDate': '2020-08-07T15:17:00Z',
'shorten_links': true
})
Delete
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({
'id': 'POST ID',
'bulk': ['Post ID 1', 'Post ID 2', ...]
})
History
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,
'lastDays': 30,
})
Upload Media
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({
'file': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...',
'fileName': 'test.png',
'description': 'best image'
})
Get Media
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()
User
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 URL
Shorten a URL and return the shortened URL. See the shorten endpoint for more details.
shortenResponse = social.shorten({
'url': 'https://theURLtoShorten.com/whatmore',
})
Analytics
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({
'lastDays': 3
})
analytics = social.analyticsPost({
'id': 'Post ID',
'platforms': ['twitter', 'linkedin']
})
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.feedAdd({
'url': 'https://theRSSFeed',
'type': 'RSS',
})
Delete an RSS feed for a given ID.
feedResponse = social.feedDelete({
'id': 'Feed ID',
})
Get Commnets
Get comments for a post. Currently only on Facebook and Instagram. See the get comment endpoint for more details.
getCommentsResponse = social.getComments({
'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({
'id': 'Post Id',
'platforms': ['facebook', 'instagram'],
'comment': 'The best comment ever!',
})
Business Functions for Multiple Users - Business or Enterprise Plan Required
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 Profile
Create a new account profile under the primary account. See the create profile endpoint for more details.
createProfileResponse = social.createProfile({
'title': 'New Profile Title',
})
Delete Profile
Delete a profile owned by the primary account. See the delete profile endpoint for more details.
deleteProfileResponse = social.deleteProfile({
'profileKey': 'JI9s-kJII-9283-OMKM',
})
Generate a JWT URL
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',
})
Additional Calls
- Webhooks endpoints
- unregisterWebhook
- listWebhook
- setAutoSchedule
- deleteAutoSchedule
- listAutoSchedule
Other Packages & Integrations
We have other package and integrations such as Node NPM, Bubble.io, and Airtable + examples in C#, PHP, and Go.
Information and Support
Additional examples, responses, etc. can be found at:
RESTful API Endpoint Docs
GitHub
See our changelog for the latest and greatest.
Please contact us with your questions, or just to give us shout-out 📢!