@datafire/stackexchange

Client library for StackExchange

Installation and Usage

npm install --save @datafire/stackexchange

let stackexchange = require('@datafire/stackexchange').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Stack Exchange is a network of 130+ Q&A communities including Stack Overflow.

Actions

access_tokens.accessTokens.get

Reads the properties for a set of access tokens.

{accessTokens} can contain up to 20 access tokens. These are obtained by authenticating a user using OAuth 2.0.

This method returns a list of access_tokens.

stackexchange.access_tokens.accessTokens.get({
  "accessTokens": ""
}, context)

Input

• input object
  • accessTokens required string: String list (semicolon delimited).
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output access_tokens

access_tokens.accessTokens.invalidate.get

Immediately expires the access tokens passed. This method is meant to allow an application to discard any active access tokens it no longer needs.

{accessTokens} can contain up to 20 access tokens. These are obtained by authenticating a user using OAuth 2.0.

This method returns a list of access_tokens.

stackexchange.access_tokens.accessTokens.invalidate.get({
  "accessTokens": ""
}, context)

Input

• input object
  • accessTokens required string: String list (semicolon delimited).
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output access_tokens

answers.get

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.

stackexchange.answers.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output answers

answers.ids.get

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.

stackexchange.answers.ids.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output answers

answers.ids.comments.get

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.

stackexchange.answers.ids.comments.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output comments

apps.accessTokens.de_authenticate.get

Passing valid access_tokens to this method causes the application that created them to be de-authorized by the user associated with each access_token. This will remove the application from their apps tab, and cause all other existing access_tokens to be destroyed.

This method is meant for uninstalling applications, recovering from access_token leaks, or simply as a stronger form of /access-tokens/{accessTokens}/invalidate.

Nothing prevents a user from re-authenticate to an application that has de-authenticated itself, the user will be prompted to approve the application again however.

{accessTokens} can contain up to 20 access tokens. These are obtained by authenticating a user using OAuth 2.0.

This method returns a list of access_tokens.

stackexchange.apps.accessTokens.de_authenticate.get({
  "accessTokens": ""
}, context)

Input

• input object
  • accessTokens required string: String list (semicolon delimited).
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output access_tokens

badges.get

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.

stackexchange.badges.get({
  "site": ""
}, context)

Input

• input object
  • inname string
  • order string (values: desc, asc)
  • max string: sort = rank => string
  • min string: sort = rank => string
  • sort string (values: rank, name, type)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output badges

badges.name.get

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.

stackexchange.badges.name.get({
  "site": ""
}, context)

Input

• input object
  • inname string
  • order string (values: desc, asc)
  • max string: sort = rank => string
  • min string: sort = rank => string
  • sort string (values: rank, name)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output badges

badges.recipients.get

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.

stackexchange.badges.recipients.get({
  "site": ""
}, context)

Input

• input object
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output badges

badges.tags.get

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.

stackexchange.badges.tags.get({
  "site": ""
}, context)

Input

• input object
  • inname string
  • order string (values: desc, asc)
  • max string: sort = rank => string
  • min string: sort = rank => string
  • sort string (values: rank, name)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output badges

badges.ids.get

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.

stackexchange.badges.ids.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = rank => string
  • min string: sort = rank => string
  • sort string (values: rank, name, type)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output badges

badges.ids.recipients.get

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.

stackexchange.badges.ids.recipients.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output badges

comments.get

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.

stackexchange.comments.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output comments

comments.ids.get

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.

stackexchange.comments.ids.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output comments

comments.id.delete.post

Deletes a comment.

Use an access_token with write_access to delete a comment.

In practice, this method will never return an object.

stackexchange.comments.id.delete.post({
  "id": 0,
  "site": ""
}, context)

Input

• input object
  • id required integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.
  • preview boolean

Output

Output schema unknown

comments.id.edit.post

Edit an existing comment.

Use an access_token with write_access to edit an existing comment.

This method return the created comment.

stackexchange.comments.id.edit.post({
  "id": 0,
  "site": ""
}, context)

Input

• input object
  • id required integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.
  • body string
  • preview boolean

Output

• output created_comment

errors.get

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.

stackexchange.errors.get({}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output errors

errors.id.get

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.

stackexchange.errors.id.get({
  "id": 0
}, context)

Input

• input object
  • id required integer

Output

• output error

events.get

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.

stackexchange.events.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.
  • since integer: Unix date.

Output

• output events

filters.create.get

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.

stackexchange.filters.create.get({}, context)

Input

• input object
  • base string
  • exclude string: String list (semicolon delimited).
  • include string: String list (semicolon delimited).
  • unsafe boolean

Output

• output single_filter

filters.filters.get

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.

stackexchange.filters.filters.get({
  "filters": ""
}, context)

Input

• input object
  • filters required string: String list (semicolon delimited).

Output

• output filters

inbox.get

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.

stackexchange.inbox.get({}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output inbox_items

inbox.unread.get

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.

stackexchange.inbox.unread.get({}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • since integer: Unix date.

Output

• output inbox_items

info.get

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.

stackexchange.info.get({
  "site": ""
}, context)

Input

• input object
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output info_object

me.get

Returns the user associated with the passed access_token.

This method returns a user.

stackexchange.me.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = reputation => number
  • min string: sort = reputation => number
  • sort string (values: reputation, creation, name, modified)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output user

me.answers.get

Returns the answers owned by the user associated with the given access_token.

This method returns a list of answers.

stackexchange.me.answers.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output answers

me.associated.get

Returns all of a user's associated accounts, given an access_token for them.

This method returns a list of network users.

stackexchange.me.associated.get({}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output network_users

me.badges.get

Returns the badges earned by the user associated with the given access_token.

This method returns a list of badges.

stackexchange.me.badges.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = rank => string
  • min string: sort = rank => string
  • sort string (values: rank, name, type)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output badges

me.comments.get

Returns the comments owned by the user associated with the given access_token.

This method returns a list of comments.

stackexchange.me.comments.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output comments

me.comments.toId.get

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.

stackexchange.me.comments.toId.get({
  "toId": 0,
  "site": ""
}, context)

Input

• input object
  • toId required integer
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output comments

me.favorites.get

Returns the questions favorites by the user associated with the given access_token.

This method returns a list of questions.

stackexchange.me.favorites.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes, added)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output questions

me.inbox.get

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.

stackexchange.me.inbox.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output inbox_items

me.inbox.unread.get

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.

stackexchange.me.inbox.unread.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.
  • since integer: Unix date.

Output

• output inbox_items

me.mentioned.get

Returns the comments mentioning the user associated with the given access_token.

This method returns a list of comments.

stackexchange.me.mentioned.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output comments

me.merges.get

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.

stackexchange.me.merges.get({}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output account_merge

me.notifications.get

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.

stackexchange.me.notifications.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output notifications

me.notifications.unread.get

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.

stackexchange.me.notifications.unread.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output notifications

me.privileges.get

Returns the privileges the user identified by access_token has.

This method returns a list of privileges.

stackexchange.me.privileges.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output privileges

me.questions.get

Returns the questions owned by the user associated with the given access_token.

This method returns a list of questions.

stackexchange.me.questions.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output questions

me.questions.featured.get

Returns the questions that have active bounties offered by the user associated with the given access_token.

This method returns a list of questions.

stackexchange.me.questions.featured.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output questions

me.questions.no_answers.get

Returns the questions owned by the user associated with the given access_token that have no answers.

This method returns a list of questions.

stackexchange.me.questions.no_answers.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output questions

me.questions.unaccepted.get

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.

stackexchange.me.questions.unaccepted.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output questions

me.questions.unanswered.get

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.

stackexchange.me.questions.unanswered.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output questions

me.reputation.get

Returns the reputation changed for the user associated with the given access_token.

This method returns a list of reputation changes.

stackexchange.me.reputation.get({
  "site": ""
}, context)

Input

• input object
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output reputation_changes

me.reputation_history.get

Returns user's public reputation history.

This method returns a list of reputation_history.

stackexchange.me.reputation_history.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output reputation_history

me.reputation_history.full.get

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.

stackexchange.me.reputation_history.full.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output reputation_history

me.suggested_edits.get

Returns the suggested edits the user identified by access_token has submitted.

This method returns a list of suggested-edits.

stackexchange.me.suggested_edits.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, approval, rejection)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output suggested-edits

me.tags.get

Returns the tags the user identified by the access_token passed is active in.

This method returns a list of tags.

stackexchange.me.tags.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = popular => number
  • min string: sort = popular => number
  • sort string (values: popular, activity, name)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output tags

me.tags.tags.top_answers.get

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.

stackexchange.me.tags.tags.top_answers.get({
  "tags": "",
  "site": ""
}, context)

Input

• input object
  • tags required string: String list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output answers

me.tags.tags.top_questions.get

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.

stackexchange.me.tags.tags.top_questions.get({
  "tags": "",
  "site": ""
}, context)

Input

• input object
  • tags required string: String list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes, hot, week, month, relevance)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output questions

me.timeline.get

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.

stackexchange.me.timeline.get({
  "site": ""
}, context)

Input

• input object
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output user_timeline_objects

me.top_answer_tags.get

Returns the user identified by access_token's top 30 tags by answer score.

This method returns a list of top tag objects.

stackexchange.me.top_answer_tags.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output top_tag_objects

me.top_question_tags.get

Returns the user identified by access_token's top 30 tags by question score.

This method returns a list of top tag objects.

stackexchange.me.top_question_tags.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output top_tag_objects

me.write_permissions.get

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.

stackexchange.me.write_permissions.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output write_permissions

notifications.get

Returns a user's notifications.

This method requires an access_token, with a scope containing "read_inbox".

This method returns a list of notifications.

stackexchange.notifications.get({}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output notifications

notifications.unread.get

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.

stackexchange.notifications.unread.get({}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.

Output

• output notifications

posts.get

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.

stackexchange.posts.get({
  "site": ""
}, context)

Input

• input object
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output posts

posts.ids.get

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.

stackexchange.posts.ids.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort string (values: activity, creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output posts

posts.ids.comments.get

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.

stackexchange.posts.ids.comments.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, votes)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output comments

posts.ids.revisions.get

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.

stackexchange.posts.ids.revisions.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output revisions

posts.ids.suggested_edits.get

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.

stackexchange.posts.ids.suggested_edits.get({
  "ids": "",
  "site": ""
}, context)

Input

• input object
  • ids required string: Number list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = creation => date
  • min string: sort = creation => date
  • sort string (values: creation, approval, rejection)
  • fromdate integer: Unix date.
  • todate integer: Unix date.
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output suggested-edits

posts.id.comments.add.post

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.

stackexchange.posts.id.comments.add.post({
  "id": 0,
  "site": ""
}, context)

Input

• input object
  • id required integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.
  • body string
  • preview boolean

Output

• output created_comment

privileges.get

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.

stackexchange.privileges.get({
  "site": ""
}, context)

Input

• input object
  • pagesize integer
  • page integer
  • filter string: #Discussion
  • callback string: All API responses are JSON, we do support JSONP with the callback query parameter.
  • site required string: Each of these methods operates on a single site at a time, identified by the site parameter. This parameter can be the full domain name (ie. "stackoverflow.com"), or a short form identified by api_site_parameter on the site object.

Output

• output privileges

questions.get

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.

stackexchange.questions.get({
  "site": ""
}, context)

Input

• input object
  • tagged string: String list (semicolon delimited).
  • order string (values: desc, asc)
  • max string: sort = activity => date
  • min string: sort = activity => date
  • sort `s