← Back to catalog

Support

StackExchange

auto-generated
swirls add stackexchange
actionGETv1.0.0

get_answers

Returns all the undeleted answers in the system. The sorts accepted by this method operate on the follow fields of the answer object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of answers.

Source
actionGETv1.0.0

get_answers_ids

Gets the set of answers identified by ids. This is meant for batch fetcing of questions. A useful trick to poll for updates is to sort by activity, with a minimum date of the last time you polled. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects. The sorts accepted by this method operate on the follow fields of the answer object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of answers.

Source
actionGETv1.0.0

get_answers_ids_comments

Gets the comments on a set of answers. If you know that you have an answer id and need the comments, use this method. If you know you have a question id, use /questions/{id}/comments. If you are unsure, use /posts/{id}/comments. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for answer_id on answer objects. The sorts accepted by this method operate on the follow fields of the comment object: - creation - creation_date - votes - score creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of comments.

Source
actionGETv1.0.0

get_badges

Returns all the badges in the system. Badge sorts are a tad complicated. For the purposes of sorting (and min/max) tag_based is considered to be greater than named. This means that you can get a list of all tag based badges by passing min=tag_based, and conversely all the named badges by passing max=named, with sort=type. For ranks, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze. rank is the default sort. This method returns a list of badges.

Source
actionGETv1.0.0

get_badges_ids

Gets the badges identified in id. Note that badge ids are not constant across sites, and thus should be looked up via the /badges method. A badge id on a single site is, however, guaranteed to be stable. Badge sorts are a tad complicated. For the purposes of sorting (and min/max) tag_based is considered to be greater than named. This means that you can get a list of all tag based badges by passing min=tag_based, and conversely all the named badges by passing max=named, with sort=type. For ranks, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze. rank is the default sort. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for badge_id on badge objects. This method returns a list of badges.

Source
actionGETv1.0.0

get_badges_ids_recipients

Returns recently awarded badges in the system, constrained to a certain set of badges. As these badges have been awarded, they will have the badge.user property set. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for badge_id on badge objects. This method returns a list of badges.

Source
actionGETv1.0.0

get_badges_name

Gets all explicitly named badges in the system. A named badged stands in opposition to a tag-based badge. These are referred to as general badges on the sites themselves. For the rank sort, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze. rank is the default sort. This method returns a list of badges.

Source
actionGETv1.0.0

get_badges_recipients

Returns recently awarded badges in the system. As these badges have been awarded, they will have the badge.user property set. This method returns a list of badges.

Source
actionGETv1.0.0

get_badges_tags

Returns the badges that are awarded for participation in specific tags. For the rank sort, bronze is greater than silver which is greater than gold. Along with sort=rank, set max=gold for just gold badges, max=silver&min=silver for just silver, and min=bronze for just bronze. rank is the default sort. This method returns a list of badges.

Source
actionGETv1.0.0

get_comments

Gets all the comments on the site. If you're filtering for interesting comments (by score, creation date, etc.) make use of the sort paramter with appropriate min and max values. If you're looking to query conversations between users, instead use the /users/{ids}/mentioned and /users/{ids}/comments/{toid} methods. The sorts accepted by this method operate on the follow fields of the comment object: - creation - creation_date - votes - score creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of comments.

Source
actionGETv1.0.0

get_comments_ids

Gets the comments identified in id. This method is most useful if you have a cache of comment ids obtained through other means (such as /questions/{id}/comments) but suspect the data may be stale. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for comment_id on comment objects. The sorts accepted by this method operate on the follow fields of the comment object: - creation - creation_date - votes - score creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of comments.

Source
actionGETv1.0.0

get_errors

Returns the various error codes that can be produced by the API. This method is provided for discovery, documentation, and testing purposes, it is not expected many applications will consume it during normal operation. For testing purposes, look into the /errors/{id} method which simulates errors given a code. This method returns a list of errors.

Source
actionGETv1.0.0

get_errors_id

This method allows you to generate an error. This method is only intended for use when testing an application or library. Unlike other methods in the API, its contract is not frozen, and new error codes may be added at any time. This method results in an error, which will be expressed with a 400 HTTP status code and setting the error* properties on the wrapper object.

Source
actionGETv1.0.0

get_events

Returns a stream of events that have occurred on the site. The API considers the following "events": - posting a question - posting an answer - posting a comment - editing a post - creating a user Events are only accessible for 15 minutes after they occurred, and by default only events in the last 5 minutes are returned. You can specify the age of the oldest event returned by setting the since parameter. It is advised that developers batch events by ids and make as few subsequent requests to other methods as possible. This method returns a list of events.

Source
actionGETv1.0.0

get_filters_create

Creates a new filter given a list of includes, excludes, a base filter, and whether or not this filter should be "unsafe". Filter "safety" is defined as follows. Any string returned as a result of an API call with a safe filter will be inline-able into HTML without script-injection concerns. That is to say, no additional sanitizing (encoding, HTML tag stripping, etc.) will be necessary on returned strings. Applications that wish to handle sanitizing themselves should create an unsafe filter. All filters are safe by default, under the assumption that double-encoding bugs are more desirable than script injections. If no base filter is specified, the default filter is assumed. When building a filter from scratch, the none built-in filter is useful. When the size of the parameters being sent to this method grows to large, problems can occur. This method will accept POST requests to mitigate this. It is not expected that many applications will call this method at runtime, filters should be pre-calculated and "baked in" in the common cases. Furthermore, there are a number of built-in filters which cover common use cases. This method returns a single filter.

Source
actionGETv1.0.0

get_filters_filters

Returns the fields included by the given filters, and the "safeness" of those filters. It is not expected that this method will be consumed by many applications at runtime, it is provided to aid in debugging. {filters} can contain up to 20 semicolon delimited filters. Filters are obtained via calls to /filters/create, or by using a built-in filter. This method returns a list of filters.

Source
actionGETv1.0.0

get_inbox

Returns a user's inbox. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of inbox items.

Source
actionGETv1.0.0

get_inbox_unread

Returns the unread items in a user's inbox. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of inbox items.

Source
actionGETv1.0.0

get_info

Returns a collection of statistics about the site. Data to facilitate per-site customization, discover related sites, and aggregate statistics is all returned by this method. This data is cached very aggressively, by design. Query sparingly, ideally no more than once an hour. This method returns an info object.

Source
actionGETv1.0.0

get_me

Returns the user associated with the passed access_token. This method returns a user.

Source
actionGETv1.0.0

get_me_answers

Returns the answers owned by the user associated with the given access_token. This method returns a list of answers.

Source
actionGETv1.0.0

get_me_associated

Returns all of a user's associated accounts, given an access_token for them. This method returns a list of network users.

Source
actionGETv1.0.0

get_me_badges

Returns the badges earned by the user associated with the given access_token. This method returns a list of badges.

Source
actionGETv1.0.0

get_me_comments

Returns the comments owned by the user associated with the given access_token. This method returns a list of comments.

Source
actionGETv1.0.0

get_me_comments_toId

Returns the comments owned by the user associated with the given access_token that are in reply to the user identified by {toId}. This method returns a list of comments.

Source
actionGETv1.0.0

get_me_favorites

Returns the questions favorites by the user associated with the given access_token. This method returns a list of questions.

Source
actionGETv1.0.0

get_me_inbox

Returns the user identified by access_token's inbox. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of inbox items.

Source
actionGETv1.0.0

get_me_inbox_unread

Returns the unread items in the user identified by access_token's inbox. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of inbox items.

Source
actionGETv1.0.0

get_me_mentioned

Returns the comments mentioning the user associated with the given access_token. This method returns a list of comments.

Source
actionGETv1.0.0

get_me_merges

Returns a record of merges that have occurred involving a user identified by an access_token. This method allows you to take now invalid account ids and find what account they've become, or take currently valid account ids and find which ids were equivalent in the past. This is most useful when confirming that an account_id is in fact "new" to an application. Account merges can happen for a wide range of reasons, applications should not make assumptions that merges have particular causes. Note that accounts are managed at a network level, users on a site may be merged due to an account level merge but there is no guarantee that a merge has an effect on any particular site. This method returns a list of account_merge.

Source
actionGETv1.0.0

get_me_notifications

Returns a user's notifications, given an access_token. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of notifications.

Source
actionGETv1.0.0

get_me_notifications_unread

Returns a user's unread notifications, given an access_token. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of notifications.

Source
actionGETv1.0.0

get_me_privileges

Returns the privileges the user identified by access_token has. This method returns a list of privileges.

Source
actionGETv1.0.0

get_me_questions

Returns the questions owned by the user associated with the given access_token. This method returns a list of questions.

Source
actionGETv1.0.0

get_me_questions_featured

Returns the questions that have active bounties offered by the user associated with the given access_token. This method returns a list of questions.

Source
actionGETv1.0.0

get_me_questions_no_answers

Returns the questions owned by the user associated with the given access_token that have no answers. This method returns a list of questions.

Source
actionGETv1.0.0

get_me_questions_unaccepted

Returns the questions owned by the user associated with the given access_token that have no accepted answer. This method returns a list of questions.

Source
actionGETv1.0.0

get_me_questions_unanswered

Returns the questions owned by the user associated with the given access_token that are not considered answered. This method returns a list of questions.

Source
actionGETv1.0.0

get_me_reputation

Returns the reputation changed for the user associated with the given access_token. This method returns a list of reputation changes.

Source
actionGETv1.0.0

get_me_reputation_history

Returns user's public reputation history. This method returns a list of reputation_history.

Source
actionGETv1.0.0

get_me_reputation_history_full

Returns user's full reputation history, including private events. This method requires an access_token, with a scope containing "private_info". This method returns a list of reputation_history.

Source
actionGETv1.0.0

get_me_suggested_edits

Returns the suggested edits the user identified by access_token has submitted. This method returns a list of suggested-edits.

Source
actionGETv1.0.0

get_me_tags

Returns the tags the user identified by the access_token passed is active in. This method returns a list of tags.

Source
actionGETv1.0.0

get_me_tags_tags_top_answers

Returns the top 30 answers the user associated with the given access_token has posted in response to questions with the given tags. This method returns a list of answers.

Source
actionGETv1.0.0

get_me_tags_tags_top_questions

Returns the top 30 questions the user associated with the given access_token has posted in response to questions with the given tags. This method returns a list of questions.

Source
actionGETv1.0.0

get_me_timeline

Returns a subset of the actions the user identified by the passed access_token has taken on the site. This method returns a list of user timeline objects.

Source
actionGETv1.0.0

get_me_top_answer_tags

Returns the user identified by access_token's top 30 tags by answer score. This method returns a list of top tag objects.

Source
actionGETv1.0.0

get_me_top_question_tags

Returns the user identified by access_token's top 30 tags by question score. This method returns a list of top tag objects.

Source
actionGETv1.0.0

get_me_write_permissions

Returns the write permissions a user has via the api, given an access token. The Stack Exchange API gives users the ability to create, edit, and delete certain types. This method returns whether the passed user is capable of performing those actions at all, as well as how many times a day they can. This method does not consider the user's current quota (ie. if they've already exhausted it for today) nor any additional restrictions on write access, such as editing deleted comments. This method returns a list of write_permissions.

Source
actionGETv1.0.0

get_notifications

Returns a user's notifications. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of notifications.

Source
actionGETv1.0.0

get_notifications_unread

Returns a user's unread notifications. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of notifications.

Source
actionGETv1.0.0

get_posts

Fetches all posts (questions and answers) on the site. In many ways this method is the union of /questions and /answers, returning both sets of data albeit only the common fields. Most applications should use the question or answer specific methods, but /posts is available for those rare cases where any activity is of intereset. Examples of such queries would be: "all posts on Jan. 1st 2011" or "top 10 posts by score of all time". The sorts accepted by this method operate on the follow fields of the post object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of posts.

Source
actionGETv1.0.0

get_posts_ids

Fetches a set of posts by ids. This method is meant for grabbing an object when unsure whether an id identifies a question or an answer. This is most common with user entered data. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively. The sorts accepted by this method operate on the follow fields of the post object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of posts.

Source
actionGETv1.0.0

get_posts_ids_comments

Gets the comments on the posts identified in ids, regardless of the type of the posts. This method is meant for cases when you are unsure of the type of the post id provided. Generally, this would be due to obtaining the post id directly from a user. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively. The sorts accepted by this method operate on the follow fields of the comment object: - creation - creation_date - votes - score creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of comments.

Source
actionGETv1.0.0

get_posts_ids_revisions

Returns edit revisions for the posts identified in ids. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively. This method returns a list of revisions.

Source
actionGETv1.0.0

get_posts_ids_suggested_edits

Returns suggsted edits on the posts identified in ids. - creation - creation_date - approval - approval_date - rejection - rejection_date creation is the default sort. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for post_id, answer_id, or question_id on post, answer, and question objects respectively. This method returns a list of suggested-edits.

Source
actionGETv1.0.0

get_privileges

Returns the earnable privileges on a site. Privileges define abilities a user can earn (via reputation) on any Stack Exchange site. While fairly stable, over time they do change. New ones are introduced with new features, and the reputation requirements change as a site matures. This method returns a list of privileges.

Source
actionGETv1.0.0

get_questions

Gets all the questions on the site. This method allows you make fairly flexible queries across the entire corpus of questions on a site. For example, getting all questions asked in the the week of Jan 1st 2011 with scores of 10 or more is a single query with parameters sort=votes&min=10&fromdate=1293840000&todate=1294444800. To constrain questions returned to those with a set of tags, use the tagged parameter with a semi-colon delimited list of tags. This is an and contraint, passing tagged=c;java will return only those questions with both tags. As such, passing more than 5 tags will always return zero results. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score - hot - by the formula ordering the hot tab Does not accept min or max - week - by the formula ordering the week tab Does not accept min or max - month - by the formula ordering the month tab Does not accept min or max activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_questions_featured

Returns all the questions with active bounties in the system. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_questions_ids

Returns the questions identified in {ids}. This is most useful for fetching fresh data when maintaining a cache of question ids, or polling for changes. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_questions_ids_answers

Gets the answers to a set of questions identified in id. This method is most useful if you have a set of interesting questions, and you wish to obtain all of their answers at once or if you are polling for new or updates answers (in conjunction with sort=activity). {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects. The sorts accepted by this method operate on the follow fields of the answer object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of answers.

Source
actionGETv1.0.0

get_questions_ids_comments

Gets the comments on a question. If you know that you have an question id and need the comments, use this method. If you know you have a answer id, use /answers/{ids}/comments. If you are unsure, use /posts/{ids}/comments. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects. The sorts accepted by this method operate on the follow fields of the comment object: - creation - creation_date - votes - score creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of comments.

Source
actionGETv1.0.0

get_questions_ids_linked

Gets questions which link to those questions identified in {ids}. This method only considers questions that are linked within a site, and will never return questions from another Stack Exchange site. A question is considered "linked" when it explicitly includes a hyperlink to another question, there are no other heuristics. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score - rank - a priority sort by site applies, subject to change at any time Does not accept min or max activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_questions_ids_related

Returns questions that the site considers related to those identified in {ids}. The algorithm for determining if questions are related is not documented, and subject to change at any time. Futhermore, these values are very heavily cached, and may not update immediately after a question has been editted. It is also not guaranteed that a question will be considered related to any number (even non-zero) of questions, and a consumer should be able to handle a variable number of returned questions. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score - rank - a priority sort by site applies, subject to change at any time Does not accept min or max activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_questions_ids_timeline

Returns a subset of the events that have happened to the questions identified in id. This provides data similar to that found on a question's timeline page. Voting data is scrubbed to deter inferencing of voter identity. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for question_id on question objects. This method returns a list of question timeline events.

Source
actionGETv1.0.0

get_questions_no_answers

Returns questions which have received no answers. Compare with /questions/unanswered which mearly returns questions that the sites consider insufficiently well answered. This method corresponds roughly with the this site tab. To constrain questions returned to those with a set of tags, use the tagged parameter with a semi-colon delimited list of tags. This is an and contraint, passing tagged=c;java will return only those questions with both tags. As such, passing more than 5 tags will always return zero results. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_questions_unanswered

Returns questions the site considers to be unanswered. Note that just because a question has an answer, that does not mean it is considered answered. While the rules are subject to change, at this time a question must have at least one upvoted answer to be considered answered. To constrain questions returned to those with a set of tags, use the tagged parameter with a semi-colon delimited list of tags. This is an and contraint, passing tagged=c;java will return only those questions with both tags. As such, passing more than 5 tags will always return zero results. Compare with /questions/no-answers. This method corresponds roughly with the unanswered tab. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_revisions_ids

Returns edit revisions identified by ids in {ids}. {ids} can contain up to 20 semicolon delimited ids, to find ids programatically look for revision_guid on revision objects. Note that unlike most other id types in the API, revision_guid is a string. This method returns a list of revisions.

Source
actionGETv1.0.0

get_search

Searches a site for any questions which fit the given criteria. This method is intentionally quite limited. For more general searching, you should use a proper internet search engine restricted to the domain of the site in question. At least one of tagged or intitle must be set on this method. nottagged is only used if tagged is also set, for performance reasons. tagged and nottagged are semi-colon delimited list of tags. At least 1 tag in tagged will be on each returned question if it is passed, making it the OR equivalent of the AND version of tagged on /questions. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score - relevance - matches the relevance tab on the site itself Does not accept min or max activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_search_advanced

Searches a site for any questions which fit the given criteria. Search criteria are expressed using the following parameters: - q - a free form text parameter, will match all question properties based on an undocumented algorithm. - accepted - true to return only questions with accepted answers, false to return only those without. Omit to elide constraint. - answers - the minimum number of answers returned questions must have. - body - text which must appear in returned questions' bodies. - closed - true to return only closed questions, false to return only open ones. Omit to elide constraint. - migrated - true to return only questions migrated away from a site, false to return only those not. Omit to elide constraint. - notice - true to return only questions with post notices, false to return only those without. Omit to elide constraint. - nottagged - a semicolon delimited list of tags, none of which will be present on returned questions. - tagged - a semicolon delimited list of tags, of which at least one will be present on all returned questions. - title - text which must appear in returned questions' titles. - user - the id of the user who must own the questions returned. - url - a url which must be contained in a post, may include a wildcard. - views - the minimum number of views returned questions must have. - wiki - true to return only community wiki questions, false to return only non-community wiki ones. Omit to elide constraint. At least one additional parameter must be set if nottagged is set, for performance reasons. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score - relevance - matches the relevance tab on the site itself Does not accept min or max activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_similar

Returns questions which are similar to a hypothetical one based on a title and tag combination. This method is roughly equivalent to a site's related questions suggestion on the ask page. This method is useful for correlating data outside of a Stack Exchange site with similar content within one. Note that title must always be passed as a parameter. tagged and nottagged are optional, semi-colon delimited lists of tags. If tagged is passed it is treated as a preference, there is no guarantee that questions returned will have any of those tags. nottagged is treated as a requirement, no questions will be returned with those tags. The sorts accepted by this method operate on the follow fields of the question object: - activity - last_activity_date - creation - creation_date - votes - score - relevance - order by "how similar" the questions are, most likely candidate first with a descending order Does not accept min or max activity is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of questions.

Source
actionGETv1.0.0

get_sites

Returns all sites in the network. This method allows for discovery of new sites, and changes to existing ones. Be aware that unlike normal API methods, this method should be fetched very infrequently, it is very unusual for these values to change more than once on any given day. It is suggested that you cache its return for at least one day, unless your app encounters evidence that it has changed (such as from the /info method). The pagesize parameter for this method is unbounded, in acknowledgement that for many applications repeatedly fetching from /sites would complicate start-up tasks needlessly. This method returns a list of sites.

Source
actionGETv1.0.0

get_suggested_edits

Returns all the suggested edits in the systems. This method returns a list of suggested-edits. The sorts accepted by this method operate on the follow fields of the suggested_edit object: - creation - creation_date - approval - approval_date Does not return unapproved suggested_edits - rejection - rejection_date Does not return unrejected suggested_edits creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.

Source
actionGETv1.0.0

get_suggested_edits_ids

Returns suggested edits identified in ids. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for suggested_edit_id on suggested_edit objects. The sorts accepted by this method operate on the follow fields of the suggested_edit object: - creation - creation_date - approval - approval_date Does not return unapproved suggested_edits - rejection - rejection_date Does not return unrejected suggested_edits creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of suggested-edits.

Source
actionGETv1.0.0

get_tags

Returns the tags found on a site. The inname parameter lets a consumer filter down to tags that contain a certain substring. For example, inname=own would return both "download" and "owner" amongst others. This method returns a list of tags. The sorts accepted by this method operate on the follow fields of the tag object: - popular - count - activity - the creation_date of the last question asked with the tag - name - name popular is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.

Source
actionGETv1.0.0

get_tags_moderator_only

Returns the tags found on a site that only moderators can use. The inname parameter lets a consumer filter down to tags that contain a certain substring. For example, inname=own would return both "download" and "owner" amongst others. This method returns a list of tags. The sorts accepted by this method operate on the follow fields of the tag object: - popular - count - activity - the creation_date of the last question asked with the tag - name - name popular is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.

Source
actionGETv1.0.0

get_tags_required

Returns the tags found on a site that fulfill required tag constraints on questions. The inname parameter lets a consumer filter down to tags that contain a certain substring. For example, inname=own would return both "download" and "owner" amongst others. This method returns a list of tags. The sorts accepted by this method operate on the follow fields of the tag object: - popular - count - activity - the creation_date of the last question asked with the tag - name - name popular is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.

Source
actionGETv1.0.0

get_tags_synonyms

Returns all tag synonyms found a site. When searching for synonyms of specific tags, it is better to use /tags/{tags}/synonyms over this method. The sorts accepted by this method operate on the follow fields of the tag_synonym object: - creation - creation_date - applied - applied_count - activity - last_applied_date creation is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate. This method returns a list of tag_synonyms.

Source
actionGETv1.0.0

get_tags_tag_top_answerers_period

Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days. This is a view onto the data presented on the tag info page on the sites. This method returns a list of tag score objects.

Source
actionGETv1.0.0

get_tags_tag_top_askers_period

Returns the top 30 askers active in a single tag, of either all-time or the last 30 days. This is a view onto the data presented on the tag info page on the sites. This method returns a list of tag score objects.

Source
actionGETv1.0.0

get_tags_tags_faq

Returns the frequently asked questions for the given set of tags in {tags}. For a question to be returned, it must have all the tags in {tags} and be considered "frequently asked". The exact algorithm for determining whether a question is considered a FAQ is subject to change at any time. {tags} can contain up to 5 individual tags per request. This method returns a list of questions.

Source
actionGETv1.0.0

get_tags_tags_info

Returns tag objects representing the tags in {tags} found on the site. This method diverges from the standard naming patterns to avoid to conflicting with existing methods, due to the free form nature of tag names. This method returns a list of tags. The sorts accepted by this method operate on the follow fields of the tag object: - popular - count - activity - the creation_date of the last question asked with the tag - name - name popular is the default sort. It is possible to create moderately complex queries using sort, min, max, fromdate, and todate.

Source
actionGETv1.0.0

get_tags_tags_related

Returns the tags that are most related to those in {tags}. Including multiple tags in {tags} is equivalent to asking for "tags related to tag #1 and tag #2" not "tags related to tag #1 or tag #2". count on tag objects returned is the number of question with that tag that also share all those in {tags}. {tags} can contain up to 4 individual tags per request. This method returns a list of tags.

Source
actionGETv1.0.0

get_tags_tags_wikis

Returns the wikis that go with the given set of tags in {tags}. Be aware that not all tags have wikis. {tags} can contain up to 20 individual tags per request. This method returns a list of tag wikis.

Source
actionGETv1.0.0

get_users_id_inbox

Returns a user's inbox. This method requires an access_token, with a scope containing "read_inbox". This method is effectively an alias for /inbox. It is provided for consumers who make strong assumptions about operating within the context of a single site rather than the Stack Exchange network as a whole. {id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects. This method returns a list of inbox items.

Source
actionGETv1.0.0

get_users_id_inbox_unread

Returns the unread items in a user's inbox. This method requires an access_token, with a scope containing "read_inbox". This method is effectively an alias for /inbox/unread. It is provided for consumers who make strong assumptions about operating within the context of a single site rather than the Stack Exchange network as a whole. {id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects. This method returns a list of inbox items.

Source
actionGETv1.0.0

get_users_id_notifications

Returns a user's notifications. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of notifications.

Source
actionGETv1.0.0

get_users_id_notifications_unread

Returns a user's unread notifications. This method requires an access_token, with a scope containing "read_inbox". This method returns a list of notifications.

Source
actionGETv1.0.0

get_users_id_privileges

Returns the privileges a user has. Applications are encouraged to calculate privileges themselves, without repeated queries to this method. A simple check against the results returned by /privileges and user.user_type would be sufficient. {id} can contain only a single, to find it programatically look for user_id on user or shallow_user objects. This method returns a list of privileges.

Source
actionGETv1.0.0

get_users_id_reputation_history_full

Returns a user's full reputation history, including private events. This method requires an access_token, with a scope containing "private_info". This method returns a list of reputation_history.

Source
actionGETv1.0.0

get_users_id_top_answer_tags

Returns a single user's top tags by answer score. This a subset of the data returned on a user's tags tab. {id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects. This method returns a list of top_tag objects.

Source
actionGETv1.0.0

get_users_id_top_question_tags

Returns a single user's top tags by question score. This a subset of the data returned on a user's tags tab. {id} can contain a single id, to find it programatically look for user_id on user or shallow_user objects. This method returns a list of top_tag objects.

Source
actionGETv1.0.0

get_users_id_write_permissions

Returns the write permissions a user has via the api. The Stack Exchange API gives users the ability to create, edit, and delete certain types. This method returns whether the passed user is capable of performing those actions at all, as well as how many times a day they can. This method does not consider the user's current quota (ie. if they've already exhausted it for today) nor any additional restrictions on write access, such as editing deleted comments. This method returns a list of write_permissions.

Source
actionGETv1.0.0

get_users_ids_associated

Returns all of a user's associated accounts, given their account_ids in {ids}. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for account_id on user objects. This method returns a list of network_users.

Source
actionGETv1.0.0

get_users_ids_merges

Returns a record of merges that have occurred involving the passed account ids. This method allows you to take now invalid account ids and find what account they've become, or take currently valid account ids and find which ids were equivalent in the past. This is most useful when confirming that an account_id is in fact "new" to an application. Account merges can happen for a wide range of reasons, applications should not make assumptions that merges have particular causes. Note that accounts are managed at a network level, users on a site may be merged due to an account level merge but there is no guarantee that a merge has an effect on any particular site. This method returns a list of account_merge.

Source
actionGETv1.0.0

get_users_ids_reputation

Gets a subset of the reputation changes for users in {ids}. Reputation changes are intentionally scrubbed of some data to make it difficult to correlate votes on particular posts with user reputation changes. That being said, this method returns enough data for reasonable display of reputation trends. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects. This method returns a list of reputation objects.

Source
actionGETv1.0.0

get_users_ids_reputation_history

Returns users' public reputation history. This method returns a list of reputation_history.

Source
actionGETv1.0.0

get_users_ids_timeline

Returns a subset of the actions the users in {ids} have taken on the site. This method returns users' posts, edits, and earned badges in the order they were accomplished. It is possible to filter to just a window of activity using the fromdate and todate parameters. {ids} can contain up to 100 semicolon delimited ids, to find ids programatically look for user_id on user or shallow_user objects. This method returns a list of user timeline objects.

Source
actionPOSTv1.0.0

post_comments_id_edit

Edit an existing comment. Use an access_token with write_access to edit an existing comment. This method return the created comment.

Source
actionPOSTv1.0.0

post_posts_id_comments_add

Create a new comment. Use an access_token with write_access to create a new comment on a post. This method returns the created comment.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec