Questions tagged [documentation]
Question pertaining to the documentation provided with the API.
95
questions
3
votes
2answers
300 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 ...
1
vote
1answer
58 views
Wrong sorting parameter in documentation for question/{ids}/answers
It looks like that in the question/{ids}/answers documentation, there is a mistake:
votes – score
Shouldn't this be
votes – votes
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 ...
2
votes
1answer
210 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 ...
2
votes
1answer
88 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.
5
votes
1answer
154 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.
...
9
votes
1answer
115 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 => ...
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 ...
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
2
votes
1answer
53 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
37 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
59 views
What happened to the links to a Stack App mentioned in the documentation about write access?
The documentation about write access states:
The application responsible for creating content via the API may be indicated with a link to an app's Stack Apps post. The exact manner of display is ...
2
votes
0answers
37 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 ...
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
0answers
69 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 ...
1
vote
0answers
60 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, ...
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?
3
votes
1answer
99 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 ...
6
votes
1answer
216 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 ...
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.
2
votes
0answers
29 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):
...
2
votes
1answer
55 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
vote
1answer
72 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
52 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 ...
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 ...
4
votes
1answer
235 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 ...
20
votes
3answers
123 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 ...
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/...
10
votes
0answers
121 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. ...
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
1answer
82 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
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 :)
2
votes
0answers
29 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.
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....
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.
2
votes
0answers
21 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 ...
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 ...
4
votes
0answers
95 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://...
7
votes
1answer
660 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 ...
2
votes
1answer
78 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, ...
1
vote
1answer
88 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
42 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).
2
votes
1answer
58 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.
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 ...
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 ...
5
votes
1answer
78 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.
...
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
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
2
votes
1answer
45 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
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?