Package com.mediumapi.apiclient

Interface PlatformApi

public interface PlatformApi

  • Method Summary

    Modifier and Type
    Method
    Description
    default PlatformApiClient
    getDelegate()
     
    default org.springframework.http.ResponseEntity<MediumPlatformLatestPosts>
    latestpostsTopicSlugGet(String topicSlug)
    GET /latestposts/{topic_slug} : Get Latest Posts Returns a list of latest posts (`article_ids`) for a topic/niche (as classified by the Medium platform).
    default org.springframework.http.ResponseEntity<MediumPlatformRecommendedFeed>
    recommendedFeedTagGet(String tag, @Valid Integer page)
    GET /recommended_feed/{tag} : Get Recommended Feed Returns a list of recommended articles (`article_ids`) for the given `tag`.
    default org.springframework.http.ResponseEntity<MediumPlatformRelatedTags>
    relatedTagsTagGet(String tag)
    GET /related_tags/{tag} : Get Related Tags Returns a list of `related_tags` for the given `tag`.
    default org.springframework.http.ResponseEntity<MediumPlatformTag>
    tagTagGet(String tag)
    GET /tag/{tag} : Get Tag Info Returns tag-related information. - Name - Followers Count - Number of stories - Number of writers - Number of latest stories - Number of latest writers
    default org.springframework.http.ResponseEntity<MediumPlatformTopfeeds>
    topfeedsTagModeGet(String tag, String mode)
    GET /topfeeds/{tag}/{mode} : Get Topfeeds Returns a list of `article_ids` (length: 25) for the given `tag` and `mode`.
    default org.springframework.http.ResponseEntity<MediumPlatformTopWriters>
    topWritersTopicSlugGet(String topicSlug, @Valid Integer count)
    GET /top_writers/{topic_slug} : Get Top Writers Returns a list of top writers (`user_ids`) within a particular topic/niche (`topic_slug`). e.g. - blockchain - relationships - artificial-intelligence, etc ...

  • Method Details

    • getDelegate

      default PlatformApiClient getDelegate()

    • latestpostsTopicSlugGet

      @RequestMapping(method=GET, value="/latestposts/{topic_slug}", produces="application/json") default org.springframework.http.ResponseEntity<MediumPlatformLatestPosts> latestpostsTopicSlugGet(@PathVariable("topic_slug") String topicSlug)
      GET /latestposts/{topic_slug} : Get Latest Posts Returns a list of latest posts (`article_ids`) for a topic/niche (as classified by the Medium platform). Example of a topic/niche can be: * blockchain * relationships * mental-health, etc … These are known as `topic_slugs`. At any given moment, this endpoint will return a list of 25 articles (`article_ids`).
      Parameters:
      topicSlug - It's a unique string, usually hyphen-separated, representing a topic/niche, as classified by Medium. (required)
      Returns:
      OK (status code 200)

    • recommendedFeedTagGet

      @RequestMapping(method=GET, value="/recommended_feed/{tag}", produces="application/json") default org.springframework.http.ResponseEntity<MediumPlatformRecommendedFeed> recommendedFeedTagGet(@PathVariable("tag") String tag, @Valid @RequestParam(value="page",required=false) @Valid Integer page)
      GET /recommended_feed/{tag} : Get Recommended Feed Returns a list of recommended articles (`article_ids`) for the given `tag`. This feed is similar to Topfeeds Trending Articles. Using the `page` query string parameter, you can get the list page by page. The page number can be between 1 and 20. Each page will have up to 25 Article IDs. So at maximum, you can fetch 500 `article_ids` in 20 API calls.
      Parameters:
      tag - It's a unique string, usually hyphen-separated, representing a class of content. (required)
      page - A number between 1 and 20. (optional)
      Returns:
      OK (status code 200)

    • relatedTagsTagGet

      @RequestMapping(method=GET, value="/related_tags/{tag}", produces="application/json") default org.springframework.http.ResponseEntity<MediumPlatformRelatedTags> relatedTagsTagGet(@PathVariable("tag") String tag)
      GET /related_tags/{tag} : Get Related Tags Returns a list of `related_tags` for the given `tag`.
      Parameters:
      tag - It's a unique string, usually hyphen-separated, representing a class of content. (required)
      Returns:
      OK (status code 200)

    • tagTagGet

      @RequestMapping(method=GET, value="/tag/{tag}", produces="application/json") default org.springframework.http.ResponseEntity<MediumPlatformTag> tagTagGet(@PathVariable("tag") String tag)
      GET /tag/{tag} : Get Tag Info Returns tag-related information. - Name - Followers Count - Number of stories - Number of writers - Number of latest stories - Number of latest writers
      Parameters:
      tag - It's a unique string, usually hyphen-separated, representing a class of content. (required)
      Returns:
      OK (status code 200)

    • topWritersTopicSlugGet

      @RequestMapping(method=GET, value="/top_writers/{topic_slug}", produces="application/json") default org.springframework.http.ResponseEntity<MediumPlatformTopWriters> topWritersTopicSlugGet(@PathVariable("topic_slug") String topicSlug, @Valid @RequestParam(value="count",required=false) @Valid Integer count)
      GET /top_writers/{topic_slug} : Get Top Writers Returns a list of top writers (`user_ids`) within a particular topic/niche (`topic_slug`). e.g. - blockchain - relationships - artificial-intelligence, etc ... **Note:** You can use optional `count` query parameter to limit the number of results. The maximum number of top writers within a topic/niche will be 250.
      Parameters:
      topicSlug - It's a unique string, usually hyphen-separated, representing a topic/niche, as classified by Medium. (required)
      count - Limits the number of `article_ids` in the result. (optional)
      Returns:
      OK (status code 200)

    • topfeedsTagModeGet

      @RequestMapping(method=GET, value="/topfeeds/{tag}/{mode}", produces="application/json") default org.springframework.http.ResponseEntity<MediumPlatformTopfeeds> topfeedsTagModeGet(@PathVariable("tag") String tag, @PathVariable("mode") String mode)
      GET /topfeeds/{tag}/{mode} : Get Topfeeds Returns a list of `article_ids` (length: 25) for the given `tag` and `mode`.
      Parameters:
      tag - It's a unique string, usually hyphen-separated, representing a class of content. (required)
      mode - Mode: - `hot` : For getting trending articles - `new` : For getting latest articles - `top_year` : For getting best articles of the year - `top_month` : For getting best articles of the month - `top_week` : For getting best articles of the week - `top_all_time`: For getting best article of all time (required)
      Returns:
      OK (status code 200)