| Name | social-post-api JSON |
| Version |
1.2.4
JSON |
| download |
| home_page | https://www.ayrshare.com |
| Summary | Social Media API: Schedule posts, get analytics, manage comments for Instagram, X/Twitter, Facebook, YouTube, LinkedIn, Google Business Profile, Pinterest, Telegram, TikTok, and Reddit. |
| upload_time | 2024-12-16 04:32:53 |
| maintainer | None |
| docs_url | None |
| author | Ayrshare |
| requires_python | None |
| license | Apache License 2.0 |
| keywords |
ayrshare
social media api
social networks
social media management
social api
social publishing
social posting
social analytics
social automation
agency social
multiple user posting
instagram
youtube api
x api
twitter api
facebook api
linkedin api
reddit api
telegram api
pinterest api
google business profile api
tiktok api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Social Media APIs for Posting, Scheduling, and Analytics
The Social Media API is a Python wrapper SDK for [Ayrshare's APIs](https://www.ayrshare.com). While most of the capabliites are supported, the Python wrapper SDK is not as feature complete as the [Ayrshare's APIs](https://www.ayrshare.com/docs/introduction).
The Social Media API is a Python wrapper SDK for [Ayrshare's APIs](https://www.ayrshare.com). While most of the capabliites are supported, the Python wrapper SDK is not as feature complete as the [Ayrshare's APIs](https://www.ayrshare.com/docs/introduction).
## What is Ayrshare?
Ayrshare is a powerful set of APIs that enable you to send social media posts, get analytics, manage comments, do DMs, and more 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](https://www.ayrshare.com/docs/apis/overview).
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](https://www.ayrshare.com/docs/apis/overview).
Get started with a [free plan](https://www.ayrshare.com/pricing), or if you have a platform or manage multiple users check out the [Business Plan](https://www.ayrshare.com/business-plan-for-multiple-users/).
For more information on setup, see our installation [video](https://youtu.be/G8M6DZdtcMc) or our [Quick Start Guide](https://www.ayrshare.com/docs/quickstart).
For more information on setup, see our installation [video](https://youtu.be/G8M6DZdtcMc) or our [Quick Start Guide](https://www.ayrshare.com/docs/quickstart).
## Installation
`pip install social-post-api`
## Setup
**1.** Create a free [Ayrshare account](https://app.ayrshare.com).
**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.
## Getting Started
### Initialize Social Media API
Create a new Social Post object with your API Key.
``` python
from ayrshare import SocialPost
social = SocialPost('DJED-DKEP-SJWK-WJKS') # get an API Key at ayrshare.com
```
### 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](https://www.ayrshare.com) and have enabled X/Twitter, Facebook, and LinkedIn. Note, Instagram, Telegram, YouTube, TikTok, and Reddit also available.
``` python
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())
```
## Social API
### Post
[Published a new post](https://www.ayrshare.com/docs/apis/post/overview) 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](https://www.ayrshare.com/docs/apis/post/post) for the full capabilities.
``` python
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
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](https://www.ayrshare.com/docs/apis/post/delete-post) for more details.
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](https://www.ayrshare.com/docs/apis/post/delete-post) for more details.
``` python
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 Post
Get a post with a given post ID. Returns a promise that resolves to a post object. See the [get post endpoint](https://www.ayrshare.com/docs/apis/post/get-post) for more details.
Get a post with a given post ID. Returns a promise that resolves to a post object. See the [get post endpoint](https://www.ayrshare.com/docs/apis/post/get-post) for more details.
``` python
getResponse = social.getPost({
# Required
'id': 'POST ID',
})
```
### Retry Post
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](https://www.ayrshare.com/docs/apis/post/retry-post) for more details.
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](https://www.ayrshare.com/docs/apis/post/retry-post) for more details.
``` python
retryResponse = social.retryPost({
# Required
'id': 'POST ID',
})
```
### Update Post
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](https://www.ayrshare.com/docs/apis/post/retry-post) for more details.
``` python
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
})
```
### History
Get a [history](https://www.ayrshare.com/docs/apis/history/overview) 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](https://www.ayrshare.com/docs/apis/history/get-history) for more details.
``` python
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 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](https://www.ayrshare.com/docs/apis/media/overview) for more details.
``` python
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 Media
Get all media URLS. Returns a promise that resolves to an array of URL objects. See the [media endpoint](https://www.ayrshare.com/docs/apis/media/get-media-in-gallery) for more details.
Get all media URLS. Returns a promise that resolves to an array of URL objects. See the [media endpoint](https://www.ayrshare.com/docs/apis/media/get-media-in-gallery) for more details.
``` python
mediaResponse = social.media()
```
### Verify Media Exists
Verify that the media file exists when uploaded. See the [media verify exists endpoint](https://www.ayrshare.com/docs/apis/media/verify-media-url) for more details.
Verify that the media file exists when uploaded. See the [media verify exists endpoint](https://www.ayrshare.com/docs/apis/media/verify-media-url) for more details.
``` python
verifyResponse = social.verifyMediaExists({
# Required: URL of the media file
'mediaUrl': 'https://img.ayrshare.com/012/gb.jpg',
})
```
### Resize Image
Get image resized according to social network requirements. See the [resize image endpoint](https://www.ayrshare.com/docs/apis/media/resize) for more details.
Get image resized according to social network requirements. See the [resize image endpoint](https://www.ayrshare.com/docs/apis/media/resize) for more details.
``` python
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.
})
```
### User
Get data about the logged in [user](https://www.ayrshare.com/docs/apis/user/overview), such as post quota, used quota, active social networks, and created date. See the [user endpoint](https://www.ayrshare.com/docs/apis/user/profile-details) for more details.
``` python
user = social.user()
```
### Shorten URL
Shorten a URL and return the shortened URL. See the [shorten endpoint](https://www.ayrshare.com/docs/apis/links/create-short-link) for more details.
``` python
shortenResponse = social.shorten({
# Required: URL to shorten
'url': 'https://theURLtoShorten.com/whatmore',
})
```
### Analytics
Get [analytics](https://www.ayrshare.com/docs/apis/analytics/overview) on shortened links and shares, likes, shares, and impressions with for a post or at the accounts level. See the [analytics endpoint](https://www.ayrshare.com/docs/apis/analytics/post) for more details.
``` python
analytics = social.analyticsLinks({
# Optional range 1-7, default 1 day.
'lastDays': 3
})
```
``` python
analytics = social.analyticsPost({
'id': 'Post ID',
'platforms': ['twitter', 'linkedin'] # optional: filter by platform
})
```
### Social Analytics
Get analytics on a social network. Returns a promise that resolves to an object containing the analytics data. See the [social analytics endpoint](https://www.ayrshare.com/docs/apis/analytics/social) for more details.
```python
analytics = social.analyticsSocial({
'platforms': ['twitter', 'linkedin'] # required
})
```
### Add an RSS or Substack Feed
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](https://www.ayrshare.com/how-to-automatically-post-your-blog-or-newsletter-to-social-media/) for more info.
``` python
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 or Substack Feed
Delete an RSS feed for a given ID.
``` python
feedResponse = social.deleteFeed({
# Required: ID of the feed
'id': 'Feed ID',
})
```
### Get Feeds
Get all registered RSS feeds. Returns a promise that resolves to an array of feed objects. See the [RSS Feeds](https://www.ayrshare.com/docs/apis/feeds/overview) for more details.
``` python
feedsResponse = social.getFeeds()
```
### Update Feed
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](https://www.ayrshare.com/docs/apis/feeds/update-feed) for more details.
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](https://www.ayrshare.com/docs/apis/feeds/update-feed) for more details.
``` python
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
Get comments for a post. See the [comments endpoint](https://www.ayrshare.com/docs/apis/comments/overview) for more details.
``` python
getCommentsResponse = social.getComments({
# Required: ID of the Post
'id': 'Post Id',
})
```
### Post a Comment
Add a comment to a post. See the [create comment endpoint](https://www.ayrshare.com/docs/apis/comments/post-comment) for more details.
``` python
postCommentResponse = social.postComment({
# Required: ID of the Post
'id': 'Post Id',
'platforms': ['facebook', 'instagram'],
'comment': 'The best comment ever!',
})
```
### Delete Comments
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](https://www.ayrshare.com/docs/apis/comments/post-comment) for more details.
``` python
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 Comment
Reply to a comment. Available for Facebook, Instagram, LinkedIn, TikTok, X/Twitter, and YouTube. See the [reply comment endpoint](https://www.ayrshare.com/docs/apis/comments/reply-to-comment) for more details.
Reply to a comment. Available for Facebook, Instagram, LinkedIn, TikTok, X/Twitter, and YouTube. See the [reply comment endpoint](https://www.ayrshare.com/docs/apis/comments/reply-to-comment) for more details.
``` python
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.
})
```
## Business Functions for Multiple Users - Business or Enterprise Plan Required
The [Business Plan](https://www.ayrshare.com/business-plan-for-multiple-users/) allows you to create, manage, and post on behalf of client profiles via the API or Dashboard GUI. You can [integrate](https://www.ayrshare.com/docs/multiple-users/business-plan-overview) Ayrshare into your platform, product, or agency and give your clients social media capabilites. Please [contact us](mailto:contact@ayrshare.com) with any questions.
A User Profile PROFILE_KEY can be set with the `setProfileKey` method.
``` python
social = SocialPost(API_KEY)
social.setProfileKey('PROFILE_KEY')
```
Replace `PROFILE_KEY` with the PROFILE_KEY of the profile you want to use.
Please see the [Authorization](https://www.ayrshare.com/docs/apis/overview#authorization) docs for more details.
### Create Profile
Create a new account [profile](https://www.ayrshare.com/docs/apis/profiles/overview) under the primary account. See the [create profile endpoint](https://www.ayrshare.com/docs/apis/profiles/create-profile) for more details.
``` python
createProfileResponse = social.createProfile({
# Required: title
'title': 'New Profile Title',
})
```
### Delete Profile
Delete a profile owned by the primary account. See the [delete profile endpoint](https://www.ayrshare.com/docs/apis/profiles/delete-profile) for more details.
Delete a profile owned by the primary account. See the [delete profile endpoint](https://www.ayrshare.com/docs/apis/profiles/delete-profile) for more details.
``` python
deleteProfileResponse = social.deleteProfile({
# Required: profileKey - the API Key of the profile to delete
'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](https://www.ayrshare.com/docs/apis/profiles/generate-jwt) for more details.
Generate a JWT Token and URL used for authorizing a user's access to the Social Account linking page. See the [generate JWT endpoint](https://www.ayrshare.com/docs/apis/profiles/generate-jwt) for more details.
``` python
generateJWTResponse = social.generateJWT({
'domain': 'mydomain',
'privateKey': 'private key data...',
'profileKey': 'JI9s-kJII-9283-OMKM',
})
```
### Update Profile
Update a profile owned by the primary account. See the [update profile endpoint](https://www.ayrshare.com/docs/apis/profiles/update-profile) for more details.
Update a profile owned by the primary account. See the [update profile endpoint](https://www.ayrshare.com/docs/apis/profiles/update-profile) for more details.
``` python
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 Profiles
Get all the profiles associated with the primary account. See the [get profile endpoint](https://www.ayrshare.com/docs/apis/profiles/get-profiles) for more details.
Get all the profiles associated with the primary account. See the [get profile endpoint](https://www.ayrshare.com/docs/apis/profiles/get-profiles) for more details.
``` python
getProfileResponse = social.getProfiles()
```
### Unlink Social Network
Unlink a social account for a given user profile owned by the primary account. See the [unlink social network endpoint](https://www.ayrshare.com/docs/apis/profiles/unlink-social-network) for more details.
Unlink a social account for a given user profile owned by the primary account. See the [unlink social network endpoint](https://www.ayrshare.com/docs/apis/profiles/unlink-social-network) for more details.
``` python
unlinkResponse = social.unlinkSocial({
'profileKey': "JI9s-kJII-9283-OMKM", # Required: profileKey - the API Key of the profile to unlink for.
'platform': "facebook"
})
```
### Get Brand Info on a User
Get brand information on users and companies public social media accounts. See the [brand endpoint](https://www.ayrshare.com/docs/apis/brand/overview) for more details.
``` python
brandResponse = social.getBrandByUser({
'platforms': ['instagram', 'facebook'],
'instagramUser': '@ayrshare',
'facebookUser': 'ayrshare',
})
```
### Auto Hashtags
Automatically add hashtags to your post. See the [auto hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/overview) for more details.
``` python
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.
})
```
### Recommend Hashtags
Get suggestions for hashtags based on a keyword. See the [recommend hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/recommend-hashtags) for more details.
Get suggestions for hashtags based on a keyword. See the [recommend hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/recommend-hashtags) for more details.
``` python
recommendHashtagsResponse = social.recommendHashtags({
'keyword': 'social media', # required: Keyword to get hashtags for.
})
```
### Check Banned Hashtags
Check if a hashtag is banned on Instagram or other social networks. See the [check banned hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/check-hashtags) for more details.
Check if a hashtag is banned on Instagram or other social networks. See the [check banned hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/check-hashtags) for more details.
``` python
checkBannedHashtagsResponse = social.checkBannedHashtags({
'hashtag': 'socialmedia', # required: Hashtag to check.
})
```
### Get All Reviews
Retrieve all the reviews for the specified platform. See the [get all reviews endpoint](https://www.ayrshare.com/docs/apis/reviews/get-reviews) for more details.
Retrieve all the reviews for the specified platform. See the [get all reviews endpoint](https://www.ayrshare.com/docs/apis/reviews/get-reviews) for more details.
``` python
allReviewsResponse = social.reviews({
'platform': 'facebook', # required: Platform to get reviews for. Currently available: "facebook", "gmb"
})
```
### Get Single Review
Retrieve a single review. See the [get single review endpoint](https://www.ayrshare.com/docs/apis/reviews/get-one-review) for more details.
Retrieve a single review. See the [get single review endpoint](https://www.ayrshare.com/docs/apis/reviews/get-one-review) for more details.
``` python
singleReviewResponse = social.review({
'id': 'Review ID', # required
'platform': 'gmb', # required: Platform to get review for. Currently available: "gmb"
})
```
### Reply to Review
Reply to a review. See the [reply to review endpoint](https://www.ayrshare.com/docs/apis/reviews/reply-review) for more details.
Reply to a review. See the [reply to review endpoint](https://www.ayrshare.com/docs/apis/reviews/reply-review) for more details.
``` python
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 Review Reply
Delete a review reply. See the [delete review reply endpoint](https://www.ayrshare.com/docs/apis/reviews/reply-review) for more details.
``` python
deleteReplyReviewResponse = social.deleteReplyReview({
'reviewId': 'Review ID', # required: Review ID to delete reply for.
'platform': 'gmb', # required: Platform to delete reply for. Currently available: "gmb"
})
```
## Max Pack Required
### Generate Post
Generate a new social post using ChatGPT. Token limits applicable. See the [generate post endpoint](https://www.ayrshare.com/docs/apis/generate/post-text) for more details.
Generate a new social post using ChatGPT. Token limits applicable. See the [generate post endpoint](https://www.ayrshare.com/docs/apis/generate/post-text) for more details.
``` python
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 Rewrite
Generate variations of a social media post using ChatGPT. Token limits applicable. See the [generate rewrite endpoint](https://www.ayrshare.com/docs/apis/generate/rewrite-post) for more details.
Generate variations of a social media post using ChatGPT. Token limits applicable. See the [generate rewrite endpoint](https://www.ayrshare.com/docs/apis/generate/rewrite-post) for more details.
``` python
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
})
```
### Generate Transcription
Provide a transcription of a video file. See the [generate transcription endpoint](https://www.ayrshare.com/docs/apis/generate/transcribe-video) for more details.
Provide a transcription of a video file. See the [generate transcription endpoint](https://www.ayrshare.com/docs/apis/generate/transcribe-video) for more details.
``` python
generateTranscriptionResponse = social.generateTranscription({
'videoUrl': 'https://theVideo.mp4', # required: URL encoded video URL. The video must be hosted by Ayrshare.
})
```
### Generate Translation
Translate text for a post to over 100 different languages. See the [generate translation endpoint](https://www.ayrshare.com/docs/apis/generate/translate-post) for more details.
Translate text for a post to over 100 different languages. See the [generate translation endpoint](https://www.ayrshare.com/docs/apis/generate/translate-post) for more details.
``` python
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.
})
```
### Generate Sentiment Analysis
Generate a sentiment analysis on a social media post or comment to understand if the text is positive, negative, or neutral and recommendations on improving the text for a more positive reaction. See the [generate sentiment analysis endpoint](https://www.ayrshare.com/docs/apis/generate/sentiment) for more details.
``` python
generateSentiment= social.generateSentiment({
'text': 'I love social media' # required: The text to generate a sentiment analysis for.
})
```
### Generate Alt Text
Create AI-generated alt text for your images. See the [generate alt text endpoint](https://www.ayrshare.com/docs/apis/generate/sentiment) for more details.
``` python
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'
})
```
### Shorten link
Provide a URL and a shortened link will be returned. See the [shorten link endpoint](https://www.ayrshare.com/docs/apis/links/overview) for more details.
``` python
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
})
```
### Analytics for Shortened Links
Return analytics for all shortened links or a single link for a given link ID. See the [analytics link endpoint](https://www.ayrshare.com/docs/apis/links/link-analytics) for more details.
Return analytics for all shortened links or a single link for a given link ID. See the [analytics link endpoint](https://www.ayrshare.com/docs/apis/links/link-analytics) for more details.
``` python
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.
})
```
### Additional Calls
- [Webhooks endpoints](https://www.ayrshare.com/docs/apis/webhooks/overview)
- [Webhooks endpoints](https://www.ayrshare.com/docs/apis/webhooks/overview)
- unregisterWebhook
- listWebhook
- setAutoSchedule
- deleteAutoSchedule
- listAutoSchedule
## Other Packages & Integrations
We have other package and integrations such as [Node NPM](https://www.ayrshare.com/docs/packages-guides/nodejs), [Bubble.io](https://www.ayrshare.com/docs/packages-guides/bubble), [Make](https://www.ayrshare.com/docs/packages-guides/make), and [Airtable](https://www.ayrshare.com/docs/packages-guides/airtable).
### Information and Support
Additional examples, responses, etc. can be found at:
[RESTful API Endpoint Docs](https://www.ayrshare.com/docs/apis/overview)
[RESTful API Endpoint Docs](https://www.ayrshare.com/docs/apis/overview)
[GitHub](https://github.com/ayrshare/social-post-api-python)
See our [changelog](https://www.ayrshare.com/docs/whatsnew/latest) for the latest and greatest.
See our [changelog](https://www.ayrshare.com/docs/whatsnew/latest) for the latest and greatest.
Please [contact us](mailto:support@ayrshare.com) with your questions, or just to give us shout-out 📢!
Raw data
{
"_id": null,
"home_page": "https://www.ayrshare.com",
"name": "social-post-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Ayrshare, Social Media API, Social Networks, Social Media Management, Social API, Social Publishing, Social Posting, Social Analytics, Social Automation, Agency Social, Multiple User Posting, Instagram, YouTube API, X API, Twitter API, Facebook API, LinkedIn API, Reddit API, Telegram API, Pinterest API, Google Business Profile API, TikTok API",
"author": "Ayrshare",
"author_email": "support@ayrshare.com",
"download_url": "https://files.pythonhosted.org/packages/a1/3f/f881a33c391f6ce924c0e7560870e969f2ad6a0c759b71eb85765dbbb434/social-post-api-1.2.4.tar.gz",
"platform": null,
"description": "# Social Media APIs for Posting, Scheduling, and Analytics\n\n\n\nThe Social Media API is a Python wrapper SDK for [Ayrshare's APIs](https://www.ayrshare.com). While most of the capabliites are supported, the Python wrapper SDK is not as feature complete as the [Ayrshare's APIs](https://www.ayrshare.com/docs/introduction).\nThe Social Media API is a Python wrapper SDK for [Ayrshare's APIs](https://www.ayrshare.com). While most of the capabliites are supported, the Python wrapper SDK is not as feature complete as the [Ayrshare's APIs](https://www.ayrshare.com/docs/introduction).\n\n## What is Ayrshare?\n\nAyrshare is a powerful set of APIs that enable you to send social media posts, get analytics, manage comments, do DMs, and more to *X/Twitter*, *Instagram*, *Facebook*, *LinkedIn*, *YouTube*, *Google Busienss Profile*, *Pinterest*, *TikTok*, *Reddit*, and *Telegram* on behalf of your users or clients.\n\nThe 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](https://www.ayrshare.com/docs/apis/overview).\nThe 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](https://www.ayrshare.com/docs/apis/overview).\n\nGet started with a [free plan](https://www.ayrshare.com/pricing), or if you have a platform or manage multiple users check out the [Business Plan](https://www.ayrshare.com/business-plan-for-multiple-users/).\n\nFor more information on setup, see our installation [video](https://youtu.be/G8M6DZdtcMc) or our [Quick Start Guide](https://www.ayrshare.com/docs/quickstart).\nFor more information on setup, see our installation [video](https://youtu.be/G8M6DZdtcMc) or our [Quick Start Guide](https://www.ayrshare.com/docs/quickstart).\n\n## Installation\n\n`pip install social-post-api`\n\n## Setup\n\n**1.** Create a free [Ayrshare account](https://app.ayrshare.com).\n\n \n\n**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.\n\n \n \n**3.** Copy your API Key from the Ayrshare dashboard. Used for authentication.\n\n \n\n## Getting Started\n\n### Initialize Social Media API\n\nCreate a new Social Post object with your API Key.\n\n``` python\nfrom ayrshare import SocialPost\nsocial = SocialPost('DJED-DKEP-SJWK-WJKS') # get an API Key at ayrshare.com\n```\n\n### History, Post, Delete Example\n\nThis simple example shows how to post, get history, and delete the post. This example assumes you have a free API key from [Ayrshare](https://www.ayrshare.com) and have enabled X/Twitter, Facebook, and LinkedIn. Note, Instagram, Telegram, YouTube, TikTok, and Reddit also available.\n\n``` python\nfrom ayrshare import SocialPost\nsocial = SocialPost('8jKj782Aw8910dCN') # get an API Key at ayrshare.com\n\n# Post to Platforms Twitter, Facebook, and LinkedIn\npostResult = social.post({'post': 'Nice Posting 2', 'platforms': ['twitter', 'facebook', 'linkedin']})\nprint(postResult)\n\n# Delete\ndeleteResult = social.delete({'id': postResult['id']})\nprint(deleteResult)\n\n# History\nprint(social.history())\n```\n\n## Social API\n\n### Post\n\n[Published a new post](https://www.ayrshare.com/docs/apis/post/overview) 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](https://www.ayrshare.com/docs/apis/post/post) for the full capabilities.\n\n``` python\npostResponse = social.post({\n # Required\n 'post': 'Best post ever!',\n\n # Required: Social media platforms to post.\n # Accepts an array of strings with values: \"facebook\", \"twitter\", \"linkedin\", \"pinterest\", \"reddit\", or \"telegram\".\n 'platforms': ['twitter', 'facebook', 'linkedin', 'pinterest', 'telegram', 'instagram'],\n\n # Optional: URLs of images to include in the post or for Instagram\n 'mediaUrls': ['https://img.ayrshare.com/012/gb.jpg'],\n\n # Optional: Datetime to schedule a future post. \n # Accepts an ISO-8601 UTC date time in format \"YYYY-MM-DDThh:mm:ssZ\". Example: 2021-07-08T12:30:00Z\n 'scheduleDate': '2020-08-07T15:17:00Z',\n\n # Optional: Shorten links in the post for all platforms similar to bit.ly.\n # Only URLS starting with http or https will be shortened. Default value: true.\n 'shorten_links': true\n})\n```\n\n### Delete\n\nDelete 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](https://www.ayrshare.com/docs/apis/post/delete-post) for more details.\nDelete 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](https://www.ayrshare.com/docs/apis/post/delete-post) for more details.\n\n``` python\ndeleteResponse = social.delete({\n # Required\n 'id': 'POST ID', # Optional, but required if \"bulk\" not present\n 'bulk': ['Post ID 1', 'Post ID 2', ...] # Optional, but required if \"id\" not present\n })\n```\n\n### Get Post\n\nGet a post with a given post ID. Returns a promise that resolves to a post object. See the [get post endpoint](https://www.ayrshare.com/docs/apis/post/get-post) for more details.\nGet a post with a given post ID. Returns a promise that resolves to a post object. See the [get post endpoint](https://www.ayrshare.com/docs/apis/post/get-post) for more details.\n\n``` python\ngetResponse = social.getPost({\n # Required\n 'id': 'POST ID',\n })\n```\n\n### Retry Post\n\nRetry 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](https://www.ayrshare.com/docs/apis/post/retry-post) for more details.\nRetry 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](https://www.ayrshare.com/docs/apis/post/retry-post) for more details.\n\n``` python\nretryResponse = social.retryPost({\n # Required\n 'id': 'POST ID',\n })\n```\n\n### Update Post\n\nUpdate 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](https://www.ayrshare.com/docs/apis/post/retry-post) for more details.\n\n``` python\nupdateResponse = social.updatePost({\n 'id': 'POST ID', # Required: ID of the post to update\n 'scheduleDate': '2024-08-07T15:17:00Z', # Optional: Datetime to schedule a future post.\n 'approved': 'true', # Optional: Approve the post to send it.\n 'youTubeOptions': { # Optional: YouTube specific options\n 'title': 'New Title',\n 'description': 'New Description',\n 'visibility': 'unlisted',\n 'categoryId': 24,\n },\n 'notes': 'New notes', # optional: Notes about the post\n })\n``` \n\n### History\n\nGet a [history](https://www.ayrshare.com/docs/apis/history/overview) 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](https://www.ayrshare.com/docs/apis/history/get-history) for more details.\n\n``` python\nhistoryResponse = social.history({\n 'lastRecords': 10, # optional: returns the last X number of history records\n 'lastDays': 30, # optional: returns the last X number of days of history records. Defaults to 30 if not present.\n})\n```\n\n### Upload Media\n\nUpload and store a new image. Returns a URL referencing the image. Can be used in \"image_url\" in \"post\". See the [media endpoint](https://www.ayrshare.com/docs/apis/media/overview) for more details.\n\n``` python\nuploadResponse = social.upload({\n # Required: The image as a Base64 encoded string. Example encoding: https://www.base64-image.de/\n 'file': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...',\n\n # Optional\n 'fileName': 'test.png',\n\n # Optional\n 'description': 'best image'\n})\n```\n\n### Get Media\n\nGet all media URLS. Returns a promise that resolves to an array of URL objects. See the [media endpoint](https://www.ayrshare.com/docs/apis/media/get-media-in-gallery) for more details.\nGet all media URLS. Returns a promise that resolves to an array of URL objects. See the [media endpoint](https://www.ayrshare.com/docs/apis/media/get-media-in-gallery) for more details.\n\n``` python\nmediaResponse = social.media()\n```\n\n### Verify Media Exists\n\nVerify that the media file exists when uploaded. See the [media verify exists endpoint](https://www.ayrshare.com/docs/apis/media/verify-media-url) for more details.\nVerify that the media file exists when uploaded. See the [media verify exists endpoint](https://www.ayrshare.com/docs/apis/media/verify-media-url) for more details.\n\n``` python\nverifyResponse = social.verifyMediaExists({\n # Required: URL of the media file\n 'mediaUrl': 'https://img.ayrshare.com/012/gb.jpg',\n})\n```\n\n### Resize Image\n\nGet image resized according to social network requirements. See the [resize image endpoint](https://www.ayrshare.com/docs/apis/media/resize) for more details.\nGet image resized according to social network requirements. See the [resize image endpoint](https://www.ayrshare.com/docs/apis/media/resize) for more details.\n\n``` python\nresizeResponse = social.resizeImage({\n 'imageUrl': \"https://theImage.jpg\", # required: URL of the image to resize\n 'platform': \"facebook\" # required: Platform to resize the image for. \n 'watermarkUrl': \"https:#theWatermark.png\", # optional: URL of the watermark image to add to the image.\n 'effects': { color: \"#A020F0\" } # optional: Change opacity, colors, etc. See endpoint for more details.\n 'dimensions': { width: 1200, height: 628 } # optional: Width and height of the image. Required if platform is not specified.\n 'mode': \"blur\" # optional. See endpoint for more details.\n})\n```\n\n### User\n\nGet data about the logged in [user](https://www.ayrshare.com/docs/apis/user/overview), such as post quota, used quota, active social networks, and created date. See the [user endpoint](https://www.ayrshare.com/docs/apis/user/profile-details) for more details.\n\n``` python\nuser = social.user()\n```\n\n### Shorten URL\n\nShorten a URL and return the shortened URL. See the [shorten endpoint](https://www.ayrshare.com/docs/apis/links/create-short-link) for more details.\n\n``` python\nshortenResponse = social.shorten({\n # Required: URL to shorten\n 'url': 'https://theURLtoShorten.com/whatmore',\n })\n```\n\n### Analytics\n\nGet [analytics](https://www.ayrshare.com/docs/apis/analytics/overview) on shortened links and shares, likes, shares, and impressions with for a post or at the accounts level. See the [analytics endpoint](https://www.ayrshare.com/docs/apis/analytics/post) for more details.\n\n``` python\nanalytics = social.analyticsLinks({\n # Optional range 1-7, default 1 day.\n 'lastDays': 3\n})\n```\n\n``` python\nanalytics = social.analyticsPost({\n 'id': 'Post ID',\n 'platforms': ['twitter', 'linkedin'] # optional: filter by platform\n})\n```\n\n### Social Analytics\n\nGet analytics on a social network. Returns a promise that resolves to an object containing the analytics data. See the [social analytics endpoint](https://www.ayrshare.com/docs/apis/analytics/social) for more details.\n\n```python\nanalytics = social.analyticsSocial({\n 'platforms': ['twitter', 'linkedin'] # required\n})\n```\n\n### Add an RSS or Substack Feed\n\nAdd 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](https://www.ayrshare.com/how-to-automatically-post-your-blog-or-newsletter-to-social-media/) for more info.\n\n``` python\nfeedResponse = social.addFeed({\n # Required: URL to shorten\n 'url': 'https://theRSSFeed',\n\n # Optional: Value: \"rss\" or \"substack\". \n # If not set, defaults to \"rss\"\n 'type': 'RSS',\n})\n```\n\n### Delete an RSS or Substack Feed\n\nDelete an RSS feed for a given ID.\n\n``` python\nfeedResponse = social.deleteFeed({\n # Required: ID of the feed\n 'id': 'Feed ID',\n})\n```\n\n### Get Feeds\n\nGet all registered RSS feeds. Returns a promise that resolves to an array of feed objects. See the [RSS Feeds](https://www.ayrshare.com/docs/apis/feeds/overview) for more details.\n\n``` python\nfeedsResponse = social.getFeeds()\n```\n\n### Update Feed\n\nUpdate an RSS feed for a given ID. Returns a promise that resolves to an object containing the feed ID. See the [update feed endpoint](https://www.ayrshare.com/docs/apis/feeds/update-feed) for more details.\nUpdate an RSS feed for a given ID. Returns a promise that resolves to an object containing the feed ID. See the [update feed endpoint](https://www.ayrshare.com/docs/apis/feeds/update-feed) for more details.\n\n``` python\nfeedResponse = social.updateFeed({\n 'id': 'Feed ID', # required: ID of the feed\n 'useFirstImage': 'true', # optional: Use the first image in the article to add to the post.\n 'autoHashtag': 'true', # optional: Automatically add hashtags to the post.\n })\n```\n\n### Get Comments\n\nGet comments for a post. See the [comments endpoint](https://www.ayrshare.com/docs/apis/comments/overview) for more details.\n\n``` python\ngetCommentsResponse = social.getComments({\n # Required: ID of the Post\n 'id': 'Post Id',\n})\n```\n\n### Post a Comment\n\nAdd a comment to a post. See the [create comment endpoint](https://www.ayrshare.com/docs/apis/comments/post-comment) for more details.\n\n``` python\npostCommentResponse = social.postComment({\n # Required: ID of the Post\n 'id': 'Post Id',\n 'platforms': ['facebook', 'instagram'],\n 'comment': 'The best comment ever!',\n})\n```\n\n### Delete Comments\n\nDelete 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](https://www.ayrshare.com/docs/apis/comments/post-comment) for more details.\n\n``` python\ndeleteCommentResponse = social.deleteComments({\n 'id': \"Pkdo9sjk2\", # required: Post top-level ID or social comment ID\n 'platforms': [\"instagram\", \"facebook\"], # optional: Required only if using the social comment id.\n })\n```\n\n### Reply Comment\n\nReply to a comment. Available for Facebook, Instagram, LinkedIn, TikTok, X/Twitter, and YouTube. See the [reply comment endpoint](https://www.ayrshare.com/docs/apis/comments/reply-to-comment) for more details.\nReply to a comment. Available for Facebook, Instagram, LinkedIn, TikTok, X/Twitter, and YouTube. See the [reply comment endpoint](https://www.ayrshare.com/docs/apis/comments/reply-to-comment) for more details.\n\n``` python\nreplyCommentResponse = social.replyComment({\n 'commentId': 'Pkdo9sjk2', # required: The Ayrshare commentId returned from the POST comment endpoint. Be sure to use the top level commentId.\n 'platforms': ['instagram', 'facebook'], # required: Array of platforms to post the reply. Values: facebook, instagram, linkedin, tiktok, twitter, youtube\n 'comment': 'What a comment' # required: The reply to add to the comment.\n })\n```\n\n## Business Functions for Multiple Users - Business or Enterprise Plan Required\n\nThe [Business Plan](https://www.ayrshare.com/business-plan-for-multiple-users/) allows you to create, manage, and post on behalf of client profiles via the API or Dashboard GUI. You can [integrate](https://www.ayrshare.com/docs/multiple-users/business-plan-overview) Ayrshare into your platform, product, or agency and give your clients social media capabilites. Please [contact us](mailto:contact@ayrshare.com) with any questions.\n\nA User Profile PROFILE_KEY can be set with the `setProfileKey` method.\n\n``` python\nsocial = SocialPost(API_KEY)\nsocial.setProfileKey('PROFILE_KEY')\n```\n\nReplace `PROFILE_KEY` with the PROFILE_KEY of the profile you want to use.\n\nPlease see the [Authorization](https://www.ayrshare.com/docs/apis/overview#authorization) docs for more details.\n\n### Create Profile\n\nCreate a new account [profile](https://www.ayrshare.com/docs/apis/profiles/overview) under the primary account. See the [create profile endpoint](https://www.ayrshare.com/docs/apis/profiles/create-profile) for more details.\n\n``` python\ncreateProfileResponse = social.createProfile({\n # Required: title\n 'title': 'New Profile Title',\n})\n```\n\n### Delete Profile\n\nDelete a profile owned by the primary account. See the [delete profile endpoint](https://www.ayrshare.com/docs/apis/profiles/delete-profile) for more details.\nDelete a profile owned by the primary account. See the [delete profile endpoint](https://www.ayrshare.com/docs/apis/profiles/delete-profile) for more details.\n\n``` python\ndeleteProfileResponse = social.deleteProfile({\n # Required: profileKey - the API Key of the profile to delete\n 'profileKey': 'JI9s-kJII-9283-OMKM',\n })\n```\n\n### Generate a JWT URL\n\nGenerate a JWT Token and URL used for authorizing a user's access to the Social Account linking page. See the [generate JWT endpoint](https://www.ayrshare.com/docs/apis/profiles/generate-jwt) for more details.\nGenerate a JWT Token and URL used for authorizing a user's access to the Social Account linking page. See the [generate JWT endpoint](https://www.ayrshare.com/docs/apis/profiles/generate-jwt) for more details.\n\n``` python\ngenerateJWTResponse = social.generateJWT({\n 'domain': 'mydomain',\n 'privateKey': 'private key data...',\n 'profileKey': 'JI9s-kJII-9283-OMKM',\n })\n```\n\n### Update Profile\n\nUpdate a profile owned by the primary account. See the [update profile endpoint](https://www.ayrshare.com/docs/apis/profiles/update-profile) for more details.\nUpdate a profile owned by the primary account. See the [update profile endpoint](https://www.ayrshare.com/docs/apis/profiles/update-profile) for more details.\n\n``` python\nupdateProfileResponse = social.updateProfile({\n 'profileKey': 'JI9s-kJII-9283-OMKM', #Required: profileKey - the API Key of the profile to update\n 'title': 'This is a great new title' #Optional: the new title of the profile\n 'disableSocial': ['facebook', 'linkedin'] #Optional: an array of social networks to disable\n 'hideTitle': 'true' #Optional: hide the title of the profile\n 'displayTitle': 'true' #Optional: display the title of the profile\n })\n```\n\n### Get Profiles\n\nGet all the profiles associated with the primary account. See the [get profile endpoint](https://www.ayrshare.com/docs/apis/profiles/get-profiles) for more details.\nGet all the profiles associated with the primary account. See the [get profile endpoint](https://www.ayrshare.com/docs/apis/profiles/get-profiles) for more details.\n\n``` python\ngetProfileResponse = social.getProfiles()\n```\n\n### Unlink Social Network\n\nUnlink a social account for a given user profile owned by the primary account. See the [unlink social network endpoint](https://www.ayrshare.com/docs/apis/profiles/unlink-social-network) for more details.\nUnlink a social account for a given user profile owned by the primary account. See the [unlink social network endpoint](https://www.ayrshare.com/docs/apis/profiles/unlink-social-network) for more details.\n\n``` python\nunlinkResponse = social.unlinkSocial({\n 'profileKey': \"JI9s-kJII-9283-OMKM\", # Required: profileKey - the API Key of the profile to unlink for.\n 'platform': \"facebook\"\n })\n```\n\n### Get Brand Info on a User\n\nGet brand information on users and companies public social media accounts. See the [brand endpoint](https://www.ayrshare.com/docs/apis/brand/overview) for more details.\n\n``` python\nbrandResponse = social.getBrandByUser({\n 'platforms': ['instagram', 'facebook'],\n 'instagramUser': '@ayrshare',\n 'facebookUser': 'ayrshare',\n })\n```\n\n### Auto Hashtags\n\nAutomatically add hashtags to your post. See the [auto hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/overview) for more details.\n\n``` python\nautoHashtagsResponse = social.autoHashtags({\n 'post': 'I love social media', # required: Post text to add hashtags for.\n 'position': 'auto' # optional: Position of the hashtags. Values: 'auto', 'end'. Default: 'auto'.\n 'max': 2 # optional: Maximum number of hashtags to add, ranging 1-5. Default: 2.\n})\n```\n\n### Recommend Hashtags\n\nGet suggestions for hashtags based on a keyword. See the [recommend hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/recommend-hashtags) for more details.\nGet suggestions for hashtags based on a keyword. See the [recommend hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/recommend-hashtags) for more details.\n\n``` python\nrecommendHashtagsResponse = social.recommendHashtags({\n 'keyword': 'social media', # required: Keyword to get hashtags for.\n})\n```\n\n### Check Banned Hashtags\n\nCheck if a hashtag is banned on Instagram or other social networks. See the [check banned hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/check-hashtags) for more details.\nCheck if a hashtag is banned on Instagram or other social networks. See the [check banned hashtags endpoint](https://www.ayrshare.com/docs/apis/hashtags/check-hashtags) for more details.\n\n``` python\ncheckBannedHashtagsResponse = social.checkBannedHashtags({\n 'hashtag': 'socialmedia', # required: Hashtag to check.\n})\n```\n\n### Get All Reviews\n\nRetrieve all the reviews for the specified platform. See the [get all reviews endpoint](https://www.ayrshare.com/docs/apis/reviews/get-reviews) for more details.\nRetrieve all the reviews for the specified platform. See the [get all reviews endpoint](https://www.ayrshare.com/docs/apis/reviews/get-reviews) for more details.\n\n``` python\nallReviewsResponse = social.reviews({\n 'platform': 'facebook', # required: Platform to get reviews for. Currently available: \"facebook\", \"gmb\"\n})\n```\n\n### Get Single Review\n\nRetrieve a single review. See the [get single review endpoint](https://www.ayrshare.com/docs/apis/reviews/get-one-review) for more details.\nRetrieve a single review. See the [get single review endpoint](https://www.ayrshare.com/docs/apis/reviews/get-one-review) for more details.\n\n``` python\nsingleReviewResponse = social.review({\n 'id': 'Review ID', # required\n 'platform': 'gmb', # required: Platform to get review for. Currently available: \"gmb\"\n})\n```\n\n### Reply to Review\n\nReply to a review. See the [reply to review endpoint](https://www.ayrshare.com/docs/apis/reviews/reply-review) for more details.\nReply to a review. See the [reply to review endpoint](https://www.ayrshare.com/docs/apis/reviews/reply-review) for more details.\n\n``` python\nreplyReviewResponse = social.replyReview({\n 'reviewId': 'Review ID', # required: Review ID to reply to.\n 'platform': 'facebook', # required: Platform to reply to review for. Currently available: \"facebook\", \"gmb\"\n 'reply': 'Thank you for the review' # required: Text of the reply to the review.\n})\n```\n\n### Delete Review Reply\n\nDelete a review reply. See the [delete review reply endpoint](https://www.ayrshare.com/docs/apis/reviews/reply-review) for more details.\n\n``` python\ndeleteReplyReviewResponse = social.deleteReplyReview({\n 'reviewId': 'Review ID', # required: Review ID to delete reply for.\n 'platform': 'gmb', # required: Platform to delete reply for. Currently available: \"gmb\"\n})\n```\n\n## Max Pack Required\n\n### Generate Post\n\nGenerate a new social post using ChatGPT. Token limits applicable. See the [generate post endpoint](https://www.ayrshare.com/docs/apis/generate/post-text) for more details.\nGenerate a new social post using ChatGPT. Token limits applicable. See the [generate post endpoint](https://www.ayrshare.com/docs/apis/generate/post-text) for more details.\n\n``` python\ngeneratePostResponse = social.generatePost({\n 'text': 'I love social media', # required: Description of what the post should be about. \n 'hashtags': 'true', #optional: Include hashtags in the post. Default: true\n 'emojis': 'true', # optional: Include emojis in the post. Default: false\n 'twitter': 'true', # optional: Construct a post 280 or few characters. Default: false\n})\n```\n\n### Generate Rewrite\n\nGenerate variations of a social media post using ChatGPT. Token limits applicable. See the [generate rewrite endpoint](https://www.ayrshare.com/docs/apis/generate/rewrite-post) for more details.\nGenerate variations of a social media post using ChatGPT. Token limits applicable. See the [generate rewrite endpoint](https://www.ayrshare.com/docs/apis/generate/rewrite-post) for more details.\n\n``` python\ngenerateRewriteResponse = social.generateRewrite({\n 'post': 'I love social media', # required: The post text to be rewritten. \n 'emojis': 'true', # optional: Include emojis in the post. Default: false\n 'hashtags': 'true', # optional: Include hashtags in the post. Default: false\n 'twitter': 'true', # optional: Construct a post 280 or few characters. Default: false\n 'rewrites': 5, # optional: Number of rewrites to generate. Default: 5\n})\n```\n\n### Generate Transcription\n\nProvide a transcription of a video file. See the [generate transcription endpoint](https://www.ayrshare.com/docs/apis/generate/transcribe-video) for more details.\nProvide a transcription of a video file. See the [generate transcription endpoint](https://www.ayrshare.com/docs/apis/generate/transcribe-video) for more details.\n\n``` python\ngenerateTranscriptionResponse = social.generateTranscription({\n 'videoUrl': 'https://theVideo.mp4', # required: URL encoded video URL. The video must be hosted by Ayrshare.\n})\n```\n\n### Generate Translation\n\nTranslate text for a post to over 100 different languages. See the [generate translation endpoint](https://www.ayrshare.com/docs/apis/generate/translate-post) for more details.\nTranslate text for a post to over 100 different languages. See the [generate translation endpoint](https://www.ayrshare.com/docs/apis/generate/translate-post) for more details.\n\n``` python\ngenerateTranslationResponse = social.generateTranslation({\n 'text': 'I love social media', # required: The text to be translated.\n 'lang': 'es', # required: The language code to translate the text to. \n})\n```\n\n### Generate Sentiment Analysis\n\nGenerate a sentiment analysis on a social media post or comment to understand if the text is positive, negative, or neutral and recommendations on improving the text for a more positive reaction. See the [generate sentiment analysis endpoint](https://www.ayrshare.com/docs/apis/generate/sentiment) for more details.\n\n``` python\ngenerateSentiment= social.generateSentiment({\n 'text': 'I love social media' # required: The text to generate a sentiment analysis for.\n})\n```\n\n### Generate Alt Text\n\nCreate AI-generated alt text for your images. See the [generate alt text endpoint](https://www.ayrshare.com/docs/apis/generate/sentiment) for more details.\n\n``` python\ngenerateAltTextResponse = social.generateAltText({\n 'url': 'https://theImage.jpg', # required: URL of the image to generate alt text for.\n 'keywords': ['social media', 'ayrshare'], # optional: Keywords to help the AI generate better alt text.\n 'lang': 'en' # optional: The language code to generate the alt text in. Default: 'en'\n})\n```\n\n### Shorten link\n\nProvide a URL and a shortened link will be returned. See the [shorten link endpoint](https://www.ayrshare.com/docs/apis/links/overview) for more details.\n\n``` python\nshortenLinkResponse = social.shortLink({\n 'url': 'https://theURL.com', # required: URL to shorten.\n 'utmId': '1234', # optional: UTM ID to track the link. See more details about utm parameters at endpoint link above.\n 'utmSource': 'source', # optional\n 'utmMedium': 'medium', # optional\n 'utmCampaign': 'campaign', # optional\n 'utmTerm': 'term', # optional\n 'utmContent': 'content', # optional\n})\n```\n\n### Analytics for Shortened Links\n\nReturn analytics for all shortened links or a single link for a given link ID. See the [analytics link endpoint](https://www.ayrshare.com/docs/apis/links/link-analytics) for more details.\nReturn analytics for all shortened links or a single link for a given link ID. See the [analytics link endpoint](https://www.ayrshare.com/docs/apis/links/link-analytics) for more details.\n\n``` python\nanalyticsLinkResponse = social.shortLinkAnalytics({\n 'id': 'Link ID', # optional: Link ID to get analytics for.\n 'fromCreatedDate': '2023-07-08T12:30:00Z', # optional: Get history of links shortened after this date.\n 'toCreatedDate': '2023-07-08T12:30:00Z', # optional: Get history of links shortened before this date.\n 'fromClickDate': '2023-07-08T12:30:00Z', # optional: Get history of links clicked after this date.\n 'toClickDate': '2023-07-08T12:30:00Z', # optional: Get history of links clicked before this date.\n})\n```\n\n### Additional Calls\n\n- [Webhooks endpoints](https://www.ayrshare.com/docs/apis/webhooks/overview)\n- [Webhooks endpoints](https://www.ayrshare.com/docs/apis/webhooks/overview)\n- unregisterWebhook\n- listWebhook\n- setAutoSchedule\n- deleteAutoSchedule\n- listAutoSchedule\n\n## Other Packages & Integrations\n\nWe have other package and integrations such as [Node NPM](https://www.ayrshare.com/docs/packages-guides/nodejs), [Bubble.io](https://www.ayrshare.com/docs/packages-guides/bubble), [Make](https://www.ayrshare.com/docs/packages-guides/make), and [Airtable](https://www.ayrshare.com/docs/packages-guides/airtable).\n\n### Information and Support\n\nAdditional examples, responses, etc. can be found at:\n\n[RESTful API Endpoint Docs](https://www.ayrshare.com/docs/apis/overview)\n[RESTful API Endpoint Docs](https://www.ayrshare.com/docs/apis/overview)\n\n[GitHub](https://github.com/ayrshare/social-post-api-python)\n\nSee our [changelog](https://www.ayrshare.com/docs/whatsnew/latest) for the latest and greatest.\nSee our [changelog](https://www.ayrshare.com/docs/whatsnew/latest) for the latest and greatest.\n\nPlease [contact us](mailto:support@ayrshare.com) with your questions, or just to give us shout-out \ud83d\udce2!\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Social Media API: Schedule posts, get analytics, manage comments for Instagram, X/Twitter, Facebook, YouTube, LinkedIn, Google Business Profile, Pinterest, Telegram, TikTok, and Reddit.",
"version": "1.2.4",
"project_urls": {
"Documentation": "https://docs.ayrshare.com",
"Homepage": "https://www.ayrshare.com",
"Source": "https://github.com/ayrshare/social-post-api-python"
},
"split_keywords": [
"ayrshare",
" social media api",
" social networks",
" social media management",
" social api",
" social publishing",
" social posting",
" social analytics",
" social automation",
" agency social",
" multiple user posting",
" instagram",
" youtube api",
" x api",
" twitter api",
" facebook api",
" linkedin api",
" reddit api",
" telegram api",
" pinterest api",
" google business profile api",
" tiktok api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3400b1aec7524ee822a65e13555e878a1954761e94894b8cc1c0cf3c955e207d",
"md5": "ac285e85b2479782d6232e30d8abf764",
"sha256": "eab26c2a222a7ad3eb07b9d160bbf540014af9ecad49d215291d5a95af63bee6"
},
"downloads": -1,
"filename": "social_post_api-1.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac285e85b2479782d6232e30d8abf764",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10101,
"upload_time": "2024-12-16T04:32:51",
"upload_time_iso_8601": "2024-12-16T04:32:51.450319Z",
"url": "https://files.pythonhosted.org/packages/34/00/b1aec7524ee822a65e13555e878a1954761e94894b8cc1c0cf3c955e207d/social_post_api-1.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a13ff881a33c391f6ce924c0e7560870e969f2ad6a0c759b71eb85765dbbb434",
"md5": "707b981deef30363fd878d15526f2f77",
"sha256": "75be333a521ef5cca4464cc27f8c89cf1c05b4a3401bee7a283ac0f765c3c55e"
},
"downloads": -1,
"filename": "social-post-api-1.2.4.tar.gz",
"has_sig": false,
"md5_digest": "707b981deef30363fd878d15526f2f77",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17391,
"upload_time": "2024-12-16T04:32:53",
"upload_time_iso_8601": "2024-12-16T04:32:53.874337Z",
"url": "https://files.pythonhosted.org/packages/a1/3f/f881a33c391f6ce924c0e7560870e969f2ad6a0c759b71eb85765dbbb434/social-post-api-1.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 04:32:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ayrshare",
"github_project": "social-post-api-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "social-post-api"
}
