All Questions
Tagged with api-help or documentation
147 questions
32
votes
1
answer
11k
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
103
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
123
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,108
5
votes
1
answer
350
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?
- 833
10
votes
0
answers
315
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
65
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://...
- 260
4
votes
0
answers
56
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
300
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 ...
- 507
0
votes
1
answer
75
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 ...
- 103
3
votes
0
answers
97
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
108
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?
- 343
4
votes
1
answer
308
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 ...
- 343
3
votes
1
answer
94
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
145
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://...
- 175
1
vote
1
answer
74
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-...
- 175
2
votes
1
answer
140
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?
1
vote
1
answer
107
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 ...
- 143
6
votes
0
answers
69
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
2
votes
1
answer
195
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 ...
- 155
2
votes
1
answer
197
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 ...
- 143
3
votes
1
answer
129
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 ...
- 23.2k
0
votes
2
answers
136
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....
- 115
2
votes
0
answers
78
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
154
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
- 373
3
votes
1
answer
252
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/...
- 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 ...
- 173
4
votes
1
answer
69
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".
- 358
2
votes
1
answer
68
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 ...
- 872
5
votes
1
answer
211
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 ...
- 872
2
votes
1
answer
84
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
52
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 it ...
- 872
2
votes
1
answer
85
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
160
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 do ...
- 23.2k
2
votes
1
answer
68
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.
- 809
2
votes
1
answer
42
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
58
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 ...
- 147
2
votes
1
answer
71
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 ...
- 12.1k
3
votes
1
answer
77
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,264
1
vote
1
answer
53
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".
user451
1
vote
1
answer
56
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.
- 111
1
vote
1
answer
52
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 ...
- 23.2k
2
votes
1
answer
63
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 ...
- 12.1k
2
votes
1
answer
39
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.
- 12.1k
4
votes
2
answers
119
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,264
2
votes
1
answer
85
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 is ...
- 872
2
votes
3
answers
104
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?
...
- 872
3
votes
1
answer
74
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
0
votes
1
answer
70
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?
- 103
3
votes
1
answer
347
views
API Time zone difference problem
I am writing a .NET application with the Stack Exchange API (using the Stacky library) and I am using it to ask the server for some questions that occured in the last hour. However, I and the server ...
- 231
1
vote
2
answers
88
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,042