GET api/articles

dev.to

Summary: Published articles
Operation ID: getArticles
Auth: unknown
Description

This endpoint allows the client to retrieve a list of articles. "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code. By default it will return featured, published articles ordered by descending popularity. It supports pagination, each page will contain `30` articles by default.

Parameters (9)

collection_id (integer, query, optional)

Adding this will allow the client to return the list of articles belonging to the requested collection, ordered by ascending publication date.

page (integer, query, optional, default: 1)

Pagination page

Constraints: {'minimum': 1}

per_page (integer, query, optional, default: 30)

Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

Constraints: {'minimum': 1, 'maximum': 1000}

state (string, query, optional)

Using this parameter will allow the client to check which articles are fresh or rising. If `state=fresh` the server will return fresh articles. If `state=rising` the server will return rising articles. This param can be used in conjuction with `username`, only if set to `all`.

Constraints: {'enum': ['fresh', 'rising', 'all']}

tag (string, query, optional)

Using this parameter will retrieve articles that contain the requested tag. Articles will be ordered by descending popularity.This parameter can be used in conjuction with `top`.

tags (string, query, optional)

Using this parameter will retrieve articles with any of the comma-separated tags. Articles will be ordered by descending popularity.

tags_exclude (string, query, optional)

Using this parameter will retrieve articles that do _not_ contain _any_ of comma-separated tags. Articles will be ordered by descending popularity.

top (integer, query, optional)

Using this parameter will allow the client to return the most popular articles in the last `N` days. `top` indicates the number of days since publication of the articles returned. This param can be used in conjuction with `tag`.

Constraints: {'minimum': 1}

username (string, query, optional)

Using this parameter will retrieve articles belonging to a User or Organization ordered by descending publication date. If `state=all` the number of items returned will be `1000` instead of the default `30`. This parameter can be used in conjuction with `state`.

No probe data for this endpoint yet.