Skip to main content

Automate social media posts via Ayrshare's API for your company or users. Post to Instagram, Twitter, Facebook, YouTube, LinkedIn, Google My Business, Pinterest, Telegram, and Reddit.

Project description

Social Media Posting and Scheduling APIs

Social Post 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, Reddit, and Telegram on behalf of your users.

The Ayrshare 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

2. Enable your social media accounts such as Twitter, Facebook, LinkedIn, Reddit, Instagram, or Telegram in the Ayrshare dashboard.

alt Social Accounts Setup

3. Copy your API Key from the Ayrshare dashboard. Used for authentication.

alt API Key

Getting Started

Initialize Social Post API

Create a new Social Post object with your API Key.

from ayrshare import SocialPost
social = SocialPost('8jKj782Aw8910dCN') # 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 and have enabled Twitter, Facebook, and LinkedIn. Note, Instagram, Telegram 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())

API

Post

Published a new post to the specified social networks either immediately or at scheduled future date. Returns a promise that resolves to an object containing the post ID and post status (success, error).

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', 'reddit'],

  # Optional: URLs of images to include in the post or for Instagram
  'media_urls': ['https://myimage.com/image.png'],

  # 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',

  # Required if platform includes "reddit." Title of Reddit post.
  'title': 'My Reddit Post',

  # Required if platform includes "reddit." Subreddit to post.
  'subreddit': 'test',

  # 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.

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
  })

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.

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".

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.

mediaResponse = social.media()

User

Get data about the logged in user, such as post quota, used quota, active social networks, and created date.

user = social.user()

Shorten URL

Shorten a URL and return the shortened URL.

shortenResponse = social.shorten({
    # Required: URL to shorten
    'url': 'https://theURLtoShorten.com/whatmore',
  })

Analytics

Get analytics on shortened links, share, likes, and impressions.

analytics = social.analyticsLinks({
  # Optional range 1-7, default 1 day.
  'lastDays': 3
})
analytics = social.analyticsPost({
  'id': 'Post ID',
  'platforms': ['twitter', 'linkedin']
})

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 for more info.

feedResponse = social.feedAdd({
  # 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.

feedResponse = social.feedDelete({
  # Required: ID of the feed
  'id': 'Feed ID',
})

Get Commnets

Get Comments for a Post

getCommentsResponse = social.getComments({
  # Required: ID of the Post
  'id': 'Post Id',
})

Post a Comment

Add a comment to a Post

postCommentResponse = social.postComment({
  # Required: ID of the Post
  'id': 'Post Id',
  'platforms': ['facebook', 'instagram'],
  'comment': 'The best comment ever!',
})

Business Plan Functions for Multiple Clients - Business Plan Required

See here for more information

Create Profile

Create a new account profile under the primary account

createProfileResponse = social.createProfile({
    # Required: title
    'title': 'New Profile Title',
})

Delete Profile

Delete a profile owned by the primary account

deleteProfileResponse = social.deleteProfile({
    # Required: profileKey - the API Key of the profile to delete
    'profileKey': 'JI9s-kJII-9283-OMKM',
  })

Generate JWT URL for SSO

Generate an SSO link. Please see integration guide provided with the Business Plan.

generateJWTResponse = social.generateJWT({
    'domain': 'mydomin',
    'privateKey': 'private key data...',
    'profileKey': 'JI9s-kJII-9283-OMKM',
  })

Additional Calls

  • registerWebhook
  • unregisterWebhook
  • listWebhook
  • setAutoSchedule
  • deleteAutoSchedule
  • listAutoSchedule

Information and Support

Additional examples, responses, etc. can be found at:

RESTful API Endpoint Docs

GitHub

Please contact us with your questions, or just to give us shout-out 📢!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for social-post-api, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size social_post_api-1.1.0-py3-none-any.whl (5.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size social-post-api-1.1.0.tar.gz (6.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page