Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

Filter by
Sorted by
Tagged with
29
votes
1answer
9k 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 ...
20
votes
3answers
121 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 ...
18
votes
1answer
254 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 ...
10
votes
0answers
120 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. ...
8
votes
1answer
112 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 => ...
8
votes
0answers
132 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/...
7
votes
1answer
656 views

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

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 ...
6
votes
1answer
188 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 ...
6
votes
1answer
112 views

What happened to the JSON documentation for the API?

Back in version 1.1 of the API, we used to be able to do: http://api.stackoverflow.com/1.1/questions?help ...which would return information about the method in JSON format. However, attempting to ...
6
votes
0answers
49 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 ...
6
votes
0answers
40 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 ...
5
votes
1answer
71 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
64 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
1answer
117 views

API docs titled "v2.0"; should be "v2.1"

The documentation is titled "StackExchange API v2.0"... this should be updated to "v2.1" as it's not readily obvious that version 2.1 has been published otherwise. https://api.stackexchange.com/docs
5
votes
1answer
64 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 ...
5
votes
1answer
307 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?
5
votes
1answer
119 views

Do the terms "key" and "access_token" refer to the same thing?

I'm trying to get my head around all the limits and throttles but some terminology is confusing me: If an application does not have an access_token, then the application shares an IP based quota ...
5
votes
1answer
152 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
110 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 ...
5
votes
1answer
28 views

Typo in API filter documentation

When using unsafe filters, the API returns the highest fidelity data is can reasonably access for the given request. should be When using unsafe filters, the API returns the highest fidelity data ...
5
votes
1answer
75 views

Enumerated types documentation in 1.1 API

I'm starting to implement requesting question and user activity in my framework, but the new 1.1 API documentation doesn't seem to indicate what the possible return values are for the fields any more. ...
5
votes
0answers
103 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.
4
votes
1answer
155 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....
4
votes
1answer
222 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 ...
4
votes
1answer
77 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 ...
4
votes
2answers
81 views

Documentation sorted by return type

Right now the documentation is pretty terribly organized. For example, consider the things under the "Users" heading: /users => returns Users /users/{ids} => returns Users /users/{ids}/answers => ...
4
votes
1answer
111 views

Confirmation on sort, order and min/max

I'd like confirmation, if possible, that the following chart of sort types is correct: sort |orderable|min/max |min/max type ------------------------------------------ activity | yes | ...
4
votes
2answers
88 views

Document fields that may be not be included in responses

I'd like to see documentation on what fields may not be included in responses or, alternatively, which fields are guaranteed to be included. Currently it's a little confusing because some fields may ...
4
votes
1answer
43 views

Stylistic error on the JavaScript SDK documentation page

There is a small stylistic error on the JavaScript SDK documentation page. Your application must have the client side OAuth flow enabled, and must not have disabled the desktop application redirect ...
4
votes
0answers
26 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. It ...
4
votes
0answers
87 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://...
3
votes
1answer
36 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
3
votes
1answer
64 views

How many ids is 'too many'?

This answer mentions limit on amount of ids included in queries like /users/{id}/mentioned, but I can't find actual amount mentioned anywhere. Now, I could run binary search and find out, but I ...
3
votes
1answer
81 views

Why is "body" missing from certain inbox items?

I have run into some confusion over the presence of the body attribute in an inbox-item returned by the /inbox method. When item_type is set to "careers_invitations", the body attribute appears to be ...
3
votes
1answer
50 views

Events: field request

The "Event" object doesn't have an easy way for getting at the object relating to the event. There's a link field, but I don't fancy having to parse the information out of that (although I could). ...
3
votes
2answers
299 views

What am I allowed/not permitted to do with the API?

I have a site that will offer technical help and assistance for a certain niche of computer users. I can either host my own forums, or tie in with stack... but I want to be able to make money off it ...
3
votes
1answer
102 views

Is there an RSS feed or question that has API changes?

Is there someplace that we can find notifications of API changes? I noticed today that a new property has been added to user along with a couple new method (and maybe other changes). Is there an ...
3
votes
2answers
69 views

Inconsistency in the handling of multiple IDs with a duplicate

There appears to be some inconsistency in the way multiple ids are being handled, especially when a duplicate exists. Duplicate ID is significant For example, when requesting a timeline of multiple ...
3
votes
1answer
76 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
56 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
157 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
94 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 ...
3
votes
1answer
91 views

Methods that return comments document body and comments parameters but they do nothing

Methods that return comments document the "body" and "comments" parameters, but they have no effect on the results, which cannot include comments and always include the body. Specific methods: /...
3
votes
1answer
51 views

Documentation has broken link (JSONP)

On Wikipedia, JSONP now has its own article, instead of being part of the JSON article. The documentation links JSONP to Wikpedia:JSON#JSONP. It should link to Wikipedia:JSONP.
3
votes
1answer
63 views

What happened to the /stats method?

I can't find the /stats method in the new usage documentation. A quick run of http://api.stackoverflow.com/1.1/stats reveals that the method is still there. However, it is not documented.
3
votes
0answers
31 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
45 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
0answers
34 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 ...
3
votes
0answers
38 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.
3
votes
0answers
40 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://...