All Questions
Tagged with api-help or documentation
147 questions
1
vote
1
answer
116
views
Why is the `site` parameter required in `/me` call?
I want to query information about the logged-in user using me, and this site parameter is creating some small problems.
I am developing a visual studio extension where upon logging in a user will get ...
- 834
3
votes
1
answer
222
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": {
"...
- 283
8
votes
0
answers
207
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/...
- 533
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
3
votes
1
answer
104
views
The /tags query is not giving me the correct results between two dates?
I'm trying to get the yearly total number of questions that have the tag browserify.
I can see that there are questions tagged from this year like this one and that one.
The site reports that there ...
- 133
5
votes
1
answer
97
views
Which reputation events are private?
I've been reading the API documentation on retrieving a user's reputation history (docs/types/reputation-history)
and Stack Overflow's description of how reputation is calculated.
But, I can't find ...
- 153
2
votes
1
answer
87
views
`fromdate` and `todate` parameter in `/me` call
What if we don't give the fromdate and/or todate parameters in a /me call?
Will it give result of user of all times? It's not mentioned explicitly in documentation.
- 834
4
votes
0
answers
74
views
'answer' type has "unchanged in unsafe filters" listed for the wrong field
http://api.stackexchange.com/docs/types/answer says the can_flag field is unchanged in unsafe filters. It's probably meant for the field above it: body_markdown.
- 273
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
3
votes
0
answers
53
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.
- 265
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
4
votes
1
answer
138
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 ...
- 253
4
votes
2
answers
136
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}
...
- 23.2k
2
votes
1
answer
81
views
Where is "items" & "badge_counts" documentation?
Where is the items & badge_counts documentation?
This is returned as JSON. I am using the /me/associated query function.
- 834
2
votes
2
answers
1k
views
Can we have maximum length of string in API help pages?
For the type "string", I think there is some upper limit of character count.
For example,
post title : 200 characters
post body : 30000 characters
In the help page, currently like this
"body": {
...
- 5,042
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
0
answers
58
views
Types missing from the "Member Types" section
The following types are not listed on http://api.stackexchange.com/docs?tab=category#docs under the Member Types section:
network_post
closed_details
original_question
Note that it's a nonexhaustive ...
- 273
1
vote
1
answer
64
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).
- 834
3
votes
4
answers
350
views
Is it really worth to (implicitly) discourage documentation of API/library usage nowadays already?
Update:
Kevin provided an answer, which, while adding something of value to the three related questions together (by naming the originating concern eventually), actually does not apply to the ...
- 1,380
3
votes
1
answer
79
views
link in post_id in /me/notifications/unread is wrong
I have run /me/notifications/unread. The response contains post_id and there is a link to it.
This link is wrong. The post is on Stack Apps but the link directs to Stack Overflow:
I have ...
- 834
3
votes
1
answer
87
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 ...
3
votes
1
answer
57
views
Clickable link in "Try It" section of some doc pages
In the "Try It" section of some doc pages, the link is not present.
It is present in the below image
Its not present in the below image
- 834
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
5
votes
1
answer
103
views
API documentation pages match some site names incorrectly
The bug is not in the API itself, but in the pages documenting its methods. To reproduce, follow the link http://api.stackexchange.com/docs/info#filter=default&site=math and observe that the page ...
1
vote
1
answer
1k
views
2
votes
0
answers
38
views
New line missing between 'notice' and 'related_site' member types
At the bottom of http://api.stackexchange.com/docs?tab=type#docs under the Member Types section, notice and related_site are on the same line. A <br> is missing between the items.
- 273
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
0
votes
1
answer
90
views
Are the "body", "comments" and "answers" parameters supported in the API version 2.x?
Earlier with version 1.x, the parameters: body, comments and answers etc. were available. But these don't seem to be supported with API version 2.x.
Are these parameters not supported in new API? Are ...
- 325
4
votes
2
answers
255
views
How to get a post title for a given post ID, even if that post ID is an answer and not a question?
I'm trying to beautify the reputation audit. If I want to show the post title for a reputation change event, however, I have a problem -- I don't know if the post ID is relative to a question or an ...
- 945
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
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
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
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
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
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 ...
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
5
votes
1
answer
120
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,264
2
votes
0
answers
25
views
'search_excerpt' type issues
On the search_excerpt page:
community_owned_date should be marked as may be absent
locked_date should be marked as may be absent
search/excerpts should be listed in the Methods That Return This Type ...
- 273
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
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
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
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 ...
5
votes
2
answers
188
views
API Help's CSS is missing
The API Help page's CSS file, located at http://sstatic.net/so/all.css, is current returning 404 for me:
<div id="header"><h1>Server Error</h1></div>
<div id="content">
...
- 819
2
votes
1
answer
143
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 ...
- 12.1k
2
votes
0
answers
81
views
Version used by StackExchange API if version is not specified in api calls
I have used some StackExchange API calls in my chrome extension - StackEye. With the release of API 2.0, I want to update the api calls so I wanted to know
New things available in 2.0+ which were not ...
- 933
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
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
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
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
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