Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

Filter by
Sorted by
Tagged with
32 votes
1 answer
10k 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 ...
  • 423
4 votes
1 answer
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 ...
1 vote
1 answer
72 views

What is the private_info scope for?

In the docs it says you can pass private_info for scope when authenticating a user. What does this allow you to access, that you couldn't otherwise?
  • 3,048
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?
10 votes
0 answers
128 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
44 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://...
4 votes
0 answers
30 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 ...
  • 141
18 votes
1 answer
260 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 ...
3 votes
0 answers
71 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 ...
  • 131
2 votes
1 answer
62 views

In the API, User object, what are all these reputation properties?

I am going through the JSON that is resulting from calling the Stack Exchange User API. I see a bunch of reputation fields. private Number reputation; private Number reputation_change_day; private ...
4 votes
0 answers
107 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://...
1 vote
1 answer
60 views

CDN redirect for the API's JavaScript SDK is incorrect

The API's JavaScript SDK is listed as https://api.stackexchange.com/js/2.0/all.js. However, GET request produces the following response: Status Code: 301 Moved Permanently Location: https://api-...
6 votes
0 answers
45 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 ...
  • 161
3 votes
1 answer
85 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 ...
  • 22.8k
2 votes
0 answers
63 views

Clarification on related tags for a tag returned by API

I was assuming that the related tags API call, returns all the tags that co-occur with the input tag. But a closer look at the API documentation indicate the following: Returns the tags that are ...
  • 121
5 votes
1 answer
120 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
36 views

Confusing documentation re vectorized requests limits

The documentation for vectorized requests says this: Most methods that take ids in the Stack Exchange API will take up to 100 of them in a single go. This allows applications to batch work and ...
5 votes
1 answer
128 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 ...
2 votes
1 answer
61 views

No token field in the docs test page for /me/reputation-history

There is no form field for an access token at: https://api.stackexchange.com/docs/me-reputation-history https://api.stackexchange.com/docs/me-full-reputation-history After attempting to Run the API ...
  • 123
5 votes
1 answer
30 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 ...
2 votes
1 answer
63 views

Where can I request an API key in the docs?

Can you mention the possibility of requesting an API key in the docs? It was displayed for the 1.0 API.
  • 315
7 votes
1 answer
117 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 ...
  • 22.8k
2 votes
1 answer
59 views

Mistake in API 2.0 Documentation - Wrong item type for Careers Message

On https://api.stackexchange.com/docs/types/inbox-item the Careers Message example shows the wrong item type.
  • 789
2 votes
1 answer
26 views

Dead link in documentation

On the docs for question timelines the link for "Question" points to /docs/type/question when it should point to /docs/types/question
4 votes
1 answer
47 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 ...
2 votes
1 answer
47 views

There is a small discrepancy in the docs for users-id-associated

The main doc page, https://api.stackexchange.com/docs, shows /users/{id}/associated while the method page, https://api.stackexchange.com/docs/associated-users, uses /users/{ids}/associated. It's ...
  • 11.5k
3 votes
1 answer
57 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). ...
  • 5,244
1 vote
1 answer
45 views

There is a typo in the authentication documentation

There is a typo on this documentation page. It says "The explcit OAuth 2.0 flow" but it should say "The explicit OAuth 2.0 flow".
user avatar
1 vote
1 answer
37 views

Minor typo in /tags/{tag}/top-askers/{period}

The discussion for the above method says "Returns the top 30 answerers active in a single tag, of either all-time or the last 30 days." It should be corrected as askers.
  • 101
1 vote
1 answer
33 views

Documentation of /users/{id}/top-answer-tags conflicts with implementation.

According to the documentation: /users/{id}/top-answer-tags or /me/top-answer-tags – Get the top 30 tags (by score) a single user has posted answers in. However in practice, when retrieving data ...
  • 22.8k
2 votes
1 answer
36 views

integer and decimal are used to describe fields in return types but not in method parameters

Integer and Decimal designations are useful in creating an accurate model of API methods and types. These specific 'number' subtypes are used when describing types but the method parameter lists all ...
  • 11.5k
2 votes
1 answer
21 views

type related_site not listed in 'by type' tab list

The type "related_site" is not listed in the 'by type' tab in documentation.
  • 11.5k
4 votes
2 answers
88 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 => ...
  • 5,244
2 votes
1 answer
51 views

Minor spello/typo on the "Complex Queries" documentation page

The documentation page Complex Queries has a minor typo or spello: The ?filter=total build-in filter is provided for just this purpose. Should instead be: The ?filter=total built-in filter ...
2 votes
3 answers
74 views

What is the "inname" parameter to the /tags 2.0 API?

I'm just playing with the new 2.0 API and in /tags there is a field inname that I can't find any description or documentation for. What does it do? Is it like the old filter parameter on the old API? ...
3 votes
1 answer
53 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.
  • 133
1 vote
2 answers
59 views

Meta Stack Overflow API Try-It form sends request to Stack Overflow API instead of Meta API

Meta Stack Overflow API Try-It form sends request to Stack Overflow API instead of Meta API
  • 5,022
3 votes
1 answer
68 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 ...
  • 1,261
5 votes
1 answer
83 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,244
3 votes
1 answer
64 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.
  • 22.8k
3 votes
2 answers
312 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
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 ...
0 votes
1 answer
96 views

/questions/tagged/{tags} - tags param clarification

This API method has been removed as of Jul 16 '10. The original question is preserved below for posterity. It is not clear what a "list" of {tags} looks like. Does this parameter follow the ...
  • 11.5k
2 votes
1 answer
112 views

Indicate in documentation whether "numbers" can be non-integral

"number" is an very ambiguous term. Integral or non-integral? For developers in more dynamically-typed languages like JavaScript, this is not an issue; but when using more statically-typed languages ...
  • 11.5k
1 vote
1 answer
83 views

Position required parameters at the top of help pages

The required id parameter for ...a lot of API routes... is now placed at the bottom of the page. It makes more sense to place required parameters at the top of the page with a slight separation, like ...
  • 11.5k
1 vote
1 answer
60 views

The user and owner objects appear to be optional in the question timeline result.

This is probably just a simple documentation fix and not really a bug. The doc for the /questions/{id}/timeline method says that the user and owner objects are not optional, but they aren't always ...
2 votes
1 answer
57 views

/users/{id} and /users/{id}/timeline - filter parameter?

Both /users/{id} and /users/{id}/timeline say they take a filter parameter for users' names, but it seems to do nothing. Are they not supposed to be there?
  • 369
3 votes
1 answer
92 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: /...
  • 369
3 votes
2 answers
71 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 ...
  • 133
4 votes
1 answer
112 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 | ...
  • 369