SlideShare API » Documentation

Get Slideshow Information

• Request type HTTPS GET
• Authorization Optional
• URL https://www.slideshare.net/api/2/get_slideshow

• slideshow_id id of the slideshow to be fetched.
• slideshow_url URL of the slideshow to be fetched. This is required if slideshow_id is not set. If both are set, slideshow_id takes precedence.

• username username of the requesting user
• password password of the requesting user
• exclude_tagsExclude tags from the detailed information. 1 to exclude.
• detailedWhether or not to include optional information. 1 to include, 0 (default) for basic information.

  <ID>{ slideshow id }</ID>
  <Title>{ slideshow title }</Title>
  <Description>{ slideshow description }</Description>
  <Status>{ 0 if queued for conversion, 1 if converting, 2 if converted,
3 if conversion failed }
  </Status>
  <Username>{ username }</Username>
  <URL>{ web permalink }</URL>
  <ThumbnailURL>{ thumbnail URL }</ThumbnailURL>
  <ThumbnailSmallURL>{ URL of smaller thumbnail }</ThumbnailSmallURL>
  <Embed>{ embed code }</Embed>
  <Created>{ date slideshow created }</Created>
  <Updated>{ date slideshow was last update }</Updated>
  <Language>{ language, as specified by two-letter code }</Language>
  <Format>ppt (or pdf, pps, odp, doc, pot, txt, rdf) </Format>
  <Download>{ 1 if available to download, else 0 }</Download>
  <DownloadUrl>{ returns if available to download }</DownloadUrl>
  <SlideshowType>{ 0 if presentation, 1 if document, 2 if a portfolio,
  3 if video }</SlideshowType>
  <InContest>{ 1 if part of a contest, 0 if not }</Download>
  <UserID>{ userID }</UserID>
  <ExternalAppUserID>{ ExternalAppUserID if uploaded using an
  external app }</ExternalAppUserID>
  <ExternalAppID>{ ExternalAppID for the external app }</ExternalAppID>
  <PPTLocation>{ PPTLocation }</ExternalAppUserID>
  <StrippedTitle>{ Stripped Title }</StrippedTitle>
  <Tags>
  <Tag Count="{ number of times tag has been used }" Owner="{ 1 if owner
has used the tag, else 0 }">{ tag name }
  </Tag>
  </Tags>
  <Audio>{ 0, or 1 if the slideshow contains audio }</Audio>
  <NumDownloads>{ number of downloads }</NumDownloads>
  <NumViews>{ number of views }</NumViews>
  <NumComments>{ number of comments }</NumComments>
  <NumFavorites>{ number of favorites }</NumFavorites>
  <NumSlides>{ number of slides }</NumSlides>
  <RelatedSlideshows>
  <RelatedSlideshowID rank="{ rank, where 1 is highest}">
  { slideshow id } </RelatedSlideshowID>
  </RelatedSlideshows>
  <PrivacyLevel>{ 0, or 1 if private }</PrivacyLevel>
  <FlagVisible>{ 1, or 0 if slideshow has been flagged }</FlagVisible>
  <ShowOnSS>{ 0, or 1 if not to be shown on Slideshare }</ShowOnSS>
  <SecretURL>{ 0, or 1 if secret URL is enabled }</SecretURL>
  <AllowEmbed>{ 0, or 1 if embeds are allowed }</AllowEmbed>
  <ShareWithContacts>{ 0, or 1 if set to private, but contacts can view
slideshow }
  </ShareWithContacts>
  </Slideshow>
      

Get Slideshows By Tag

• Request Type HTTPS GET
• Authorization None
• URL https://www.slideshare.net/api/2/get_slideshows_by_tag

• tag tag name

• limit specify number of items to return
• offset specify offset
• detailed Whether or not to include optional information. 1 to include, 0 (default) for basic information.

<Tag>
  <Name>{ Tag Name }</Name>
  <Count>{ Number of Slideshows }</Count>
  <Slideshow>
  { as in get_slideshow }
  </Slideshow>
...
</Tag>
      

Get Slideshows By User

• Request Type HTTPS GET
• Authorization None
• URL https://www.slideshare.net/api/2/get_slideshows_by_user

• username_for username of owner of slideshows

• username username of the requesting user
• password password of the requesting user
• limit specify number of items to return
• offset specify offset
• detailed Whether or not to include optional information. 1 to include, 0 (default) for basic information.
• get_unconverted Whether or not to include unconverted slideshows. 1 to include them, 0 (default) otherwise.

<User>
  <Name>{ username_for }</Name>
  <Count>{ Number of Slideshows }</Count>
  <Slideshow>
  { as in get_slideshow }
  </Slideshow>
...
</User>
      

Slideshow Search

• Request Type HTTPS GET
• Authorization None
• URL https://www.slideshare.net/api/2/search_slideshows

• q the query string

• page The page number of the results (works in conjunction with items_per_page), default is 1
• items_per_pageNumber of results to return per page, default is 12, the maximum is 50
• lang Language of slideshows (default is English, 'en') ('**':All,'es':Spanish,'pt':Portuguese,'fr':French,'it':Italian,'nl':Dutch, 'de':German,'zh':Chinese,'ja':Japanese,'ko':Korean,'ro':Romanian, '!!':Other)
• sort Sort order (default is 'relevance') ('mostviewed','mostdownloaded','latest')
• upload_date The time period you want to restrict your search to. 'week' would restrict to the last week. (default is 'any') ('week', 'month', 'year')
• what What type of search. If not set, text search is used. 'tag' is the other option.
• file_type File type to search for. Default is "all". ('presentations', 'documents', 'webinars','videos', 'infographics')
• detailed Whether or not to include optional information. 1 to include, 0 (default) for basic information.

<Slideshows>
<Meta>
  <Query>{ query }</Query>
  <ResultOffset>{ the offset of this result (if pages were used)}
  </ResultOffset>
  <NumResults>{ number of results returned }</NumResults>
  <TotalResults>{ total number of results}</TotalResults>
</Meta>

{as in get_slideshow}

...

      

Get User Favorites

• Request Type HTTPS GET
• Authorization Optional
• URL https://www.slideshare.net/api/2/get_user_favorites

• username_for username of user whose Favorites are being requested

<favorites>
  <favorite>
    <slideshow_id>{ Slideshow id }</slideshow_id>
    <tag_text>{ Tags }</tag_text>
  <favorite>
...
</favorites>
      

Get User Contacts

• Request Type HTTPS GET
• Authorization Optional
• URL https://www.slideshare.net/api/2/get_user_contacts

• username_for username of user whose Contacts are being requested

• limit specify number of items to return
• offset specify offset

<Contacts>
  <Contact>
    <Username>{ Username }</Username>
    <NumSlideshows>{ Number of Slideshows }</NumSlideshows>
    <NumComments>{ Number of Comments made by the contact }</NumComments>
  <Contact>
...
</Contacts>
      

Get User Tags

• Request Type HTTPS GET
• Authorization Required
• URL https://www.slideshare.net/api/2/get_user_tags

• username username of the requesting user
• password password of the requesting user

<Tags>
  <Tag Count="{ Number of times tag used }">{ Tag name }</Tag>
...
</Tags>
      

Edit Existing Slideshow

• Request Type HTTPS GET
• Authorization Required
• URL https://www.slideshare.net/api/2/edit_slideshow

• username username of the requesting user
• password password of the requesting user
• slideshow_id slideshow ID

• slideshow_title text
• slideshow_description text
• slideshow_tags text
• make_slideshow_private Should be Y if you want to make the slideshow private. If this is not set, following tags will not be considered
• generate_secret_url Generate a secret URL for the slideshow. Requires make_slideshow_private to be Y
• allow_embeds Sets if other websites should be allowed to embed the slideshow. Requires make_slideshow_private to be Y
• share_with_contacts Sets if your contacts on SlideShare can view the slideshow. Requires make_slideshow_private to be Y

<SlideShowEdited>
  <SlideShowID>SlideShowID</SlideShowID>
</SlideShowEdited>
      

Delete Slideshow

• Request Type HTTPS GET
• Authorization Required
• URL https://www.slideshare.net/api/2/delete_slideshow

• username username of the requesting user
• password password of the requesting user
• slideshow_id slideshow ID

<SlideShowDeleted>
  <SlideShowID>SlideShowID</SlideShowID>
</SlideShowDeleted>
      

Favorite Slideshow

• Request Type HTTPS GET
• Authorization Required
• URL https://www.slideshare.net/api/2/add_favorite

• username username of the requesting user
• password password of the requesting user
• slideshow_id the slideshow to be favorited

<SlideShow>
  <SlideShowID>SlideShowID</SlideShowID>
</SlideShow>
          

Check Favorite

• Request Type HTTPS GET
• Authorization Required
• URL https://www.slideshare.net/api/2/check_favorite

• username username of the requesting user
• password password of the requesting user
• slideshow_idSlideshow which would be favorited

<SlideShow>
  <SlideShowID>SlideShowID</SlideShowID>
  <User>User ID</User>
  <Favorited>true: Slideshow was favorited, false otherwise</Favorites>
</SlideShow>