Questions tagged [documentation]

Question pertaining to the documentation provided with the API.

Filter by
Sorted by
Tagged with
1 vote
0 answers
64 views

Get Token button in "Try it" doesn't give me a key in IE11

When I visit for example the timeline docs to try that api I need to get a token first by clicking 'Get Token'. In IE11 (win 7/x64) this is broken. A window does pop-up but there is never a key ...
rene's user avatar
  • 2,482
8 votes
0 answers
158 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/...
Besi's user avatar
  • 533
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 ...
Ranjit's user avatar
  • 423
4 votes
1 answer
81 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 ...
michaelb958--GoFundMonica's user avatar
1 vote
1 answer
84 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?
Jonathan.'s user avatar
  • 3,128
5 votes
1 answer
317 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?
Sean Allred's user avatar
10 votes
0 answers
275 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. ...
michaelb958--GoFundMonica's user avatar
3 votes
0 answers
49 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://...
ForkandBeard's user avatar
4 votes
0 answers
37 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 ...
jmac's user avatar
  • 141
18 votes
1 answer
275 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 ...
kittycat's user avatar
  • 507
0 votes
1 answer
49 views

Support for OR constraint when querying questions based on tags [duplicate]

Right now, there is no way (as far as I know) to query for questions based on multiple tags using an OR constraint. You can query for questions tagged with multiple of these tags, but not with one or ...
tolgap's user avatar
  • 103
3 votes
0 answers
78 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 ...
Dan Lugg's user avatar
  • 131
2 votes
1 answer
86 views

Top questions by tag and period

I want to get via API the most voted questions from the latest week (for example) from a specified tag (php, for example). How can I do this?
Ionică Bizău's user avatar
4 votes
1 answer
287 views

How do I parse the dates from the API?

I see that JSON returned by the API contains dates in the following format: "creation_date":1364546475 ^^^^^^^^^^ What's the meaning of it? How can I parse it to get the date in the ...
Ionică Bizău's user avatar
3 votes
1 answer
65 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 ...
Nicholas DiPiazza's user avatar
4 votes
0 answers
118 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://...
Andrey Shchekin's user avatar
1 vote
1 answer
62 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-...
Andrey Shchekin's user avatar
2 votes
1 answer
100 views

Maximum length of "about me" in the Stack Exchange API?

What is the Maximum length of "about me" in the Stack Exchange API? The one from the /me path. And in general, where are the length limits published? If anywhere?
Nicholas DiPiazza's user avatar
1 vote
1 answer
83 views

How do I find a user by their `display_name`?

I am using Serel (the Ruby wrapper) and would like to be able to find a user by their display_name. As it stands right now, I can only find them via an ID - like Serel::User.find(1,2,3). I tried ...
marcamillion's user avatar
6 votes
0 answers
56 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 ...
Leopd's user avatar
  • 161
2 votes
1 answer
152 views

Can you identify a user from the access_token?

I have the access_token after authentication from the user. At this point I don't know with which sites this user has registered. Is it possible to get user information like the display name or ...
aldrin's user avatar
  • 155
2 votes
1 answer
168 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 ...
marcamillion's user avatar
3 votes
1 answer
90 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 ...
Nathan Osman's user avatar
  • 23.3k
0 votes
2 answers
112 views

Ajax get questions by tags ERROR

i'm trying getting questions by tags. this is my simple code and i'm running this from my http://localhost: <script type="text/javascript"> $(function(){ $.ajax({ url:'http://api....
itsme's user avatar
  • 115
2 votes
0 answers
64 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 ...
appanponn's user avatar
  • 121
5 votes
1 answer
122 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
Alex Lockwood's user avatar
3 votes
1 answer
225 views

API documentation console unsuccessfully tries to load MiniProfiler results

All of the documentation pages (example) with the test console currently attempt to load MiniProfiler result data, which fails with a 404: POST https://api.stackexchange.com/mini-profiler-resources/...
Tim Stone's user avatar
  • 4,686
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 ...
indyfromoz's user avatar
4 votes
1 answer
51 views

Typo in the docs for /me

The doc says: Returns the user associated with the passed auth_token. This method returns a user. It should say "access_token" instead of "auth_token".
Adam Lear's user avatar
  • 358
2 votes
1 answer
39 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 ...
hippietrail's user avatar
5 votes
1 answer
154 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 ...
hippietrail's user avatar
2 votes
1 answer
64 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 ...
pb2q's user avatar
  • 123
5 votes
1 answer
35 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 ...
hippietrail's user avatar
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.
PeeHaa's user avatar
  • 315
7 votes
1 answer
123 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 ...
Nathan Osman's user avatar
  • 23.3k
2 votes
1 answer
60 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.
Adam's user avatar
  • 809
2 votes
1 answer
27 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
Charles Sprayberry's user avatar
4 votes
1 answer
52 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 ...
Octavian Helm's user avatar
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 ...
Sky Sanders's user avatar
  • 12.1k
3 votes
1 answer
58 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). ...
Dave DeLong's user avatar
  • 5,264
1 vote
1 answer
46 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
38 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.
laktek's user avatar
  • 111
1 vote
1 answer
35 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 ...
Nathan Osman's user avatar
  • 23.3k
2 votes
1 answer
38 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 ...
Sky Sanders's user avatar
  • 12.1k
2 votes
1 answer
24 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.
Sky Sanders's user avatar
  • 12.1k
4 votes
2 answers
93 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 => ...
Dave DeLong's user avatar
  • 5,264
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 ...
hippietrail's user avatar
2 votes
3 answers
75 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? ...
hippietrail's user avatar
3 votes
1 answer
56 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.
TRiG's user avatar
  • 133
0 votes
1 answer
55 views

Make API query to only one Stack Exchange site

Is there a way to limit a /search or a /similar query to a specific site or sites?
swasheck's user avatar
  • 103