Stack Exchange Network

Stack Exchange network consists of 174 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

4
votes
1answer
34 views

Please “release” and/or document API version 2.3

I was playing around a bit with Fiddler to capture traffic from the Stack Exchange iOS app. To my surprise, it uses version 2.3 of the Stack Exchange API: I noticed here that it has some extra ...
2
votes
0answers
20 views

.wrapper not sorted correctly in filter edit popup

When editing the filter, e.g. on this API documentation page, all types are sorted alphabetically except for .wrapper which is always shown below answer, instead of above it (or at the end): ...
5
votes
0answers
35 views

Typos in API documentation

From the /posts documentation: Most applications should use the question or answer specific methods, but /posts is available for those rare cases where any activity is of intereset. intereset => ...
2
votes
1answer
32 views

What are the top level question & answer localized flag_option titles?

For the SE API, the endpoints dealing with flags (e.g. /questions/{id}/flags/options) return the flag_option type. However, the option_id values are explicitly stated as being unstable, but it's ...
0
votes
1answer
44 views

Can the API Edit a Question, changing only one field?

The documentation for the edit question method (/questions/{id}/edit) is somewhat vague. Are all of the parameters required? For example, if the only field I want to change in the question is tags, ...
6
votes
0answers
30 views

Docs say the API returns a user's age, but it doesn't (anymore)

The doc page says that the user object returns an age property (for those users that specified an age). But the API  no  longer  does.   (Plus spot checks of users that had age in ...
1
vote
0answers
22 views

Spelling mistake in API Documentation's “Authentication” page

Can you find the spelling mistake in "Unregistered Users" (last section) of the Authentication page? In case you're not in the mood for games, here is it: This is actually a correct spelling - of ...
2
votes
1answer
78 views

My filter is not returning any results. How to create a minimal filter?

I'm having trouble getting the SO API Filters to cooperate. I've gone over the documentation as well as similar questions like this and this. I'll use this call as an example since it successfully ...
2
votes
1answer
36 views

What does “in practice” mean here?

From /answers/{id}/delete: In practice, this method will never return an object. For me, "in practice" means that the method will maybe return an object. But why? That's not good from an ...
2
votes
0answers
26 views

“users” link lands on the answer page

On the /users/moderators documentation site, the following link is wrong: This method returns a list of users. The users link mistakenly points to the answers object instead of to the users object....
3
votes
0answers
34 views

Authorization dialog shows wrong API version

If you go on this doc page and click on Get Token, you'll see this: Minor bug, but still, I thought it would be nice to fix this inconsistency :)
3
votes
1answer
105 views

“Try It” URL has wrong URI

On API doc pages, the “link” link at the top-right of the “Try It” sections presents a URL with the wrong domain name: For example, on docs/similar, the URL displayed will be: https://api....
19
votes
3answers
88 views

Documentation or API method for `option_id` information, for the `/flags/options` API calls?

The Stack Exchange API has a couple of calls that return a list of flag_option objects. These objects contain a couple of properties that can be used to identify the flag you need. For example, when ...
2
votes
0answers
19 views

'search_excerpt' type issues

On the search_excerpt page: community_owned_date should be marked as may be absent locked_date should be marked as may be absent search/excerpts should be listed in the Methods That Return This Type ...
2
votes
0answers
30 views

Types missing from the “Member Types” section

The following types are not listed on http://api.stackexchange.com/docs?tab=category#docs under the Member Types section: network_post closed_details original_question Note that it's a nonexhaustive ...
2
votes
0answers
26 views

New line missing between 'notice' and 'related_site' member types

At the bottom of http://api.stackexchange.com/docs?tab=type#docs under the Member Types section, notice and related_site are on the same line. A <br> is missing between the items.
3
votes
0answers
35 views

'answer' type has “unchanged in unsafe filters” listed for the wrong field

http://api.stackexchange.com/docs/types/answer says the can_flag field is unchanged in unsafe filters. It's probably meant for the field above it: body_markdown.
2
votes
1answer
71 views

Notice field on questions may be absent?

The notice type, that is a field of a question, appears to be optional, yet it is not marked as "may be absent"? For example, when I request questions with a filter that has the notice field checked, ...
4
votes
0answers
95 views

Few typos in the documentation pages

https://api.stackexchange.com/docs/vectors When passing a vector, sepeate each id with a semicolon. For example, /users/1;2;3;4;5?site=somesite would fetch users with ids 1 through 5 on somesite. ...
5
votes
1answer
66 views

Typos on api.stackexchange.com/docs/js-lib

Under the Authentication section on https://api.stackexchange.com/docs/js-lib, there are a few typos (emphasis mine): scope (optional) – an array of scopes to request during authentication, valid ...
2
votes
1answer
44 views

`fromdate` and `todate` parameter in `/me` call

What if we don't give the fromdate and/or todate parameters in a /me call? Will it give result of user of all times? It's not mentioned explicitly in documentation.
1
vote
1answer
72 views

Why is the `site` parameter required in `/me` call?

I want to query information about the logged-in user using me, and this site parameter is creating some small problems. I am developing a visual studio extension where upon logging in a user will get ...
1
vote
1answer
33 views

`types=main_site` in `/me/associated` gives `meta_site` accounts also

When I run /me/associated with main_site as a parameter in types, its gives meta_site accounts also (Meta Stack Exchange profile).
3
votes
1answer
56 views

The /tags query is not giving me the correct results between two dates?

I'm trying to get the yearly total number of questions that have the tag browserify. I can see that there are questions tagged from this year like this one and that one. The site reports that there ...
3
votes
1answer
50 views

link in post_id in /me/notifications/unread is wrong

I have run /me/notifications/unread. The response contains post_id and there is a link to it. This link is wrong. The post is on Stack Apps but the link directs to Stack Overflow: I have ...
3
votes
1answer
94 views

Difference between `/inbox/unread` & `/me/inbox/unread`

I ran /inbox/unread & /me/inbox/unread. What is the difference between the two? Also, the site parameter which we give in call to /me/inbox/unread is not required as inbox_item refers to global ...
3
votes
1answer
32 views

Clickable link in “Try It” section of some doc pages

In the "Try It" section of some doc pages, the link is not present. It is present in the below image Its not present in the below image
2
votes
1answer
37 views

Where is “items” & “badge_counts” documentation?

Where is the items & badge_counts documentation? This is returned as JSON. I am using the /me/associated query function.
5
votes
1answer
64 views

Please make the site search on the API alphabetical

When I search, I want the sites to be alphabetical: Please can they be?
5
votes
1answer
53 views

Which reputation events are private?

I've been reading the API documentation on retrieving a user's reputation history (docs/types/reputation-history) and Stack Overflow's description of how reputation is calculated. But, I can't find ...
5
votes
0answers
92 views

“What is meta” should be rephrased

Stackapps.com/help/whats-meta tells that there is "Meta Stack Apps". However there isn't. Stack Apps is its own meta and meta is used to ask meta questions here.
3
votes
0answers
57 views

top-answerers / top-askers documentation bug: number of results returned incorrect

The top-answerers-on-tags and top-askers-on-tags documentation claim: Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days. and Returns the top 30 askers ...
7
votes
1answer
586 views

Application Key and AccessToken are not working for Stack Exchange API?

I have followed the documentation and used explicit OAuth 2.0 flow for access_token generation. And I have gone through all 4 steps defined under explicit OAuth 2.0 flow with scope=no_expiry. Then I ...
0
votes
1answer
46 views

Are the “body”, “comments” and “answers” parameters supported in the API version 2.x?

Earlier with version 1.x, the parameters: body, comments and answers etc. were available. But these don't seem to be supported with API version 2.x. Are these parameters not supported in new API? Are ...
5
votes
1answer
59 views

API documentation pages match some site names incorrectly

The bug is not in the API itself, but in the pages documenting its methods. To reproduce, follow the link http://api.stackexchange.com/docs/info#filter=default&site=math and observe that the page ...
1
vote
0answers
46 views

Get Token button in “Try it” doesn't give me a key in IE11

When I visit for example the timeline docs to try that api I need to get a token first by clicking 'Get Token'. In IE11 (win 7/x64) this is broken. A window does pop-up but there is never a key ...
8
votes
0answers
93 views

Incomplete information in API documentation

I am struggling a little bit with the Stack Exchange API since there seems to be no formal specification for the individual endpoints of the API. Example: Endpoint: https://api.stackexchange.com/2.2/...
22
votes
1answer
7k views

Looking for a beginner's tutorial to using the API

I see the Stack Exchange API but I'm unable to understand it. I don't think there is any fundamental tutorial showing how to use Stack Overflow fully in the API documentation. I want some fundamental ...
4
votes
1answer
68 views

“Try it” facility suffers a double-encoding bug

As you can clearly see from the above, the ampersand in the site name in the "Try It" section of the API method documentation has been double-encoded. This affects any site with an ampersand in the ...
0
votes
1answer
30 views

What is the private_info scope for?

In the docs it says you can pass private_info for scope when authenticating a user. What does this allow you to access, that you couldn't otherwise?
5
votes
1answer
278 views

Is there an offline copy of the API documentation?

I'm trying to find a way to get all the information in the API in one printable PDF, complete with the examples given in the documentation. Is there anyway I can do this?
10
votes
0answers
97 views

Tell us that POST is required to write

While troubleshooting /posts/{id}/comments/add in order to answer Why am I getting a 404 when trying to post a comment?, it was noticed that the API path in question only responded to POST requests. ...
2
votes
0answers
35 views

Incorrect link parameter on the “Complex Queries” documentation page

The "Complex Queries" documentation page has this link: Of these three posts on Server Fault, the one with the most recent activity where "the one with the most recent activity" links to https://...
4
votes
0answers
21 views

Link to applied_count leads to a 404

To Reproduce Run an API query on tag-synonyms, you will get a result that includes something like this: Issue(s) Click on the applied_count link and you get redirected to this page which is a 404. ...
18
votes
1answer
223 views

Accessing Authenticated User's Close/Delete History

I'm working on the PHP chatroom's cv-pls backlog UI. Many users and myself would like the ability to track which questions we have already handled though close/delete votes. To be able to do that I ...
3
votes
0answers
51 views

SE API V1.1 documentation, date errata

The Stack Exchange API, version 1.1, documentation is ever so slightly confusing wherever Unix timestamps are mentioned (perhaps any ranges, I haven't dug too deeply) For instance: todate – Unix ...
2
votes
1answer
49 views

In the API, User object, what are all these reputation properties?

I am going through the JSON that is resulting from calling the Stack Exchange User API. I see a bunch of reputation fields. private Number reputation; private Number reputation_change_day; private ...
2
votes
0answers
66 views

Parameter `tagged` in `search/advanced` seems to use `AND` instead of `OR`

It seems that search/advanced has the same problem as in "The tagged parameter does not work with multiple tags" question. When I select c#; .net I only get results tagged both c# and .net: http://...
1
vote
1answer
57 views

CDN redirect for the API's JavaScript SDK is incorrect

The API's JavaScript SDK is listed as https://api.stackexchange.com/js/2.0/all.js. However, GET request produces the following response: Status Code: 301 Moved Permanently Location: https://api-...
6
votes
0answers
34 views

API docs for “stack overflow” still feature v1.0 docs

I guess I'd call this a doc bug. Currently the page http://api.stackoverflow.com redirects to http://api.stackoverflow.com/1.0/usage, which says at the top "Don't use 1.0, use 2.1". This URL ...