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 ...
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. ...
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 ...
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 ...
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 ...
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 ...
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 ...
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).
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 ...
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 ...
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/...
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. ...
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
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
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 ...
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, ...