Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

Filter by
Sorted by
Tagged with
2 votes
0 answers
30 views

Uncaught channelUrl must be under the current domain

I'm developing a Stack Chrome extension that will make use of the API. I'm following the instructions on the API docs here. My OAuth and host websites are set to stackexchange.com in my Stack Apps ...
0 votes
0 answers
12 views

Strange grammar in API docs /js-lib

* This is kind of like an extension to Typos on api.stackexchange.com/docs/js-lib https://api.stackexchange.com/docs/js-lib version is provided for bug reporting purposes, few client's will use it ...
1 vote
0 answers
25 views

Typo in API docs /numbers)

https://api.stackexchange.com/docs/numbers The motivation for this is to prevent any unpleasant floating point confusion, especially across technologies that offering different floating point ...
1 vote
1 answer
69 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 ...
1 vote
1 answer
33 views

Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, incl. differences between them?

Where do I look for a new-to-the-network technical-overview introduction to what a script/app/etc. basically is, including differences between them? Basically, I'm looking for onboarding documentation ...
0 votes
0 answers
24 views

Auto-links to collectives in documentation aren't working

The Collective objects returned by the API, e.g. this method, have a link property that seems to be clickable, just like post and comment IDs in other object types: However, they lead to links like ...
3 votes
0 answers
28 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 ...
2 votes
0 answers
57 views

Update Teams API documentation to reflect dependency on tier

The documentation 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 Teams. This is slightly ...
3 votes
2 answers
315 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 ...
5 votes
1 answer
126 views

Two minor typos in the API help

In http://api.stackoverflow.com/0.8/help /users/{id}/answers Gets answer summary informatino for the user with 'id'. and in the Returns section of http://api.stackoverflow.com/0.8/help/method?method=...
3 votes
1 answer
64 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 ...
109 votes
3 answers
23k views

API Documentation and Help

Method List All API methods can be found at https://api.stackexchange.com/docs. Global Method Parameters All methods accept the following parameters: type=jsontext: responds with mime-type text/json. ...
1 vote
1 answer
66 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
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 ...
2 votes
1 answer
161 views

How do I find all questions/answers per a tag?

Would also be good if I could also find the top questions/answers in a particular tag - i.e. questions tagged with Ruby or PHP. Per the docs the only thing I can see that will return questions in a ...
5 votes
1 answer
723 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?
3 votes
1 answer
72 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 ...
6 votes
1 answer
333 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?
1 vote
1 answer
128 views

What license is the Stack Exchange API released under? MIT?

Are there any license requirements the Stack Exchange API? Which license is it released under? If I were to develop an app, would I have to credit Stack Exchange API?
2 votes
1 answer
224 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 ...
12 votes
1 answer
331 views

How the /sites method is meant to be used

The /sites method is used to enumerate all sites in the network. If your [app] is meant to run against more than a single site (and many are) this method is how you should be discovering new sites in ...
2 votes
1 answer
94 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
1 answer
163 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
1 answer
123 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
1 answer
165 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
1 answer
121 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
1 answer
55 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
0 answers
42 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
1 answer
67 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
0 answers
46 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 ...
4 votes
2 answers
107 views

Possible bug in the help page?

There are some weird dot things in this help page: api.stackoverflow.com/0.8/help/method?method=users/{id}/badges {Dead link to missing image: http://files.quickmediasolutions.com/stackbug.png} ...
4 votes
1 answer
104 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
0 answers
72 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
0 answers
63 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
1 answer
313 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
1 answer
109 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
1 answer
202 views

OBSOLETE - /search method, returning the body of the questions

Probably this is a documentation fault. For the search method, the parameter list doesn't say anything about an optional body, but looking at the Returns description shows: "body": { "...
3 votes
1 answer
174 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 ...
6 votes
1 answer
426 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
0 answers
110 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
0 answers
31 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
1 answer
62 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
1 answer
81 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
0 answers
56 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
1 answer
123 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
1 answer
306 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
3 answers
133 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
0 answers
139 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
0 answers
144 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
0 answers
33 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....