Questions tagged [documentation]
Question pertaining to the documentation provided with the API.
147 questions
2
votes
1
answer
108
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 ...
- 1,676
6
votes
1
answer
1k
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 ...
rene♦
- 2,897
2
votes
0
answers
76
views
Improve design of the Documentation's 404 page
The 404 page of the documentation has a rather awkward design; for example, a different header than other pages, and no footer. Can it be updated?
- 6,965
2
votes
1
answer
121
views
Clarify read-only vs. write operations for Teams in documentation
The API page about Stack Overflow for Teams says (emphasis mine):
Starting with the release of Stack Overflow For Teams, the Stack Exchange API exposes read-only access to data stored in private ...
- 101
3
votes
0
answers
63
views
Browsing method documentation consumes 4 quota units per page
Is it my imagination (scratch that, it's definitely not), or does simply browsing method doc pages (without using the "Run" function) consume quota?
From Bash using httpie and jq (on a ...
- 249
3
votes
2
answers
364
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 ...
- 6,965
3
votes
1
answer
87
views
Minor typo on help page
On the API Routes help page, this:
/users/{id}/favorites Gets summary information for the questions that have been favorited a set of users.
should probably be:
/users/{id}/favorites Gets ...
rene♦
- 2,897
3
votes
1
answer
4k
views
HTTP 400 "Bad Request" while using "access_token" in request Url
I registered an app, obtained a key and I have implemented the implicit OAuth 2.0 flow in a Windows 8 desktop app (as per the documentation available here). After receiving and storing the access ...
rene♦
- 2,897
5
votes
1
answer
773
views
Is it possible to authenticate a user through Stack Overflow API?
Is it possible to use the Stack Overflow API to authenticate a given user identity such as with Facebook, Twitter, or OpenID?
If it's possible: Can you tell me the method (s) that make this happen?
- 493
6
votes
1
answer
383
views
Where is the usage documentation?
I know this is probably a dumb question, but there's a bunch of documentation and I don't know what to do with this stuff. How do you use the API?
rene♦
- 2,897
3
votes
1
answer
263
views
Unable to post a comment using the interactive API documentation
I'm trying to to integrate the Stack Exchange API in my application. I'm trying the authentication but when I got the token and used it it gave a write_access issue. That issue was resolved when I ...
- 6,965
2
votes
1
answer
122
views
"Javascript" typo on documentation pages
On page Usage of /sites, it should be JavaScript, not Javascript, in the right sidebar:
This obviously also applies to (most/all) API documentation pages, since they share the sidebar.
- 201
9
votes
1
answer
165
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 => ...
- 201
5
votes
1
answer
154
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
- 201
2
votes
0
answers
67
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:
- 201
2
votes
0
answers
72
views
List /network-activity methods under Network Methods in the documentation
The API methods /users/{id}/network-activity and /me/network-activity, both return a summary of a user's activity across the Stack Exchange network and do not take a site parameter.
They are ...
- 13k
4
votes
1
answer
138
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 ...
- 13k
1
vote
0
answers
79
views
The authentication doc gives a wrong domain for authentication
The authentication doc page now lists URL's like:
https://stackoverflow.com/oauth
https://stackoverflow.com/oauth/access_token
etc.
While these seem to work, the correct domain is stackexchange.com, ...
- 13k
3
votes
1
answer
138
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 ...
- 661
3
votes
1
answer
225
views
Getting Question data using stack.PHP fails after a certain number of requests
I am trying to build an RSS feed that includes any/all questions that I have answered, and been accepted as the correct answer.
I am running into an issue where I'm sending too many requests and ...
- 13k
2
votes
0
answers
50
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):
Obviously,...
- 6,965
6
votes
0
answers
84
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 ...
- 13k
4
votes
1
answer
449
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 ...
- 13k
8
votes
0
answers
207
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/...
- 13k
3
votes
0
answers
53
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.
- 13k