All Questions
Tagged with documentation documentation or
150 questions
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?
- 103
3
votes
1
answer
320
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
62
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
0
votes
1
answer
82
views
API console always queries Stack Overflow
On any Stack Exchange site (well, I tried Super User (trilogy), Unix (SE-2.0 launched) and SFF (SE-2.0 beta)), the console (“Show Console” button) in the 1.1 API queries http://api.stackoverflow.com/1....
3
votes
0
answers
50
views
Always show console on API docs
This script stops you having to click the "show console" button to test an API call.
Install - View Source
- 796
1
vote
1
answer
61
views
Definitive on timeline_type?
Hi all,
I am trying to get a definitive on what timeline_type actually means...
I've looked at: https://stackapps.com/search?q=timeline_type but to no avail.
The new documentation doesn't list ...
- 157
3
votes
1
answer
78
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,271
5
votes
1
answer
92
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
3
votes
1
answer
178
views
Getting Question data using stack.PHP fails after a certain number of requests
I am trying to build an RSS feed that includes any/all questions that I have answered, and been accepted as the correct answer.
I am running into an issue where I'm sending too many requests and ...
- 163
3
votes
1
answer
83
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.
- 23.3k
1
vote
1
answer
132
views
What license is the Stack Exchange API released under? MIT?
Are there any license requirements the Stack Exchange API?
Which license is it released under?
If I were to develop an app, would I have to credit Stack Exchange API?
- 113
4
votes
2
answers
227
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
6
votes
1
answer
350
views
Where is the usage documentation?
I know this is probably a dumb question, but there's a bunch of documentation and I don't know what to do with this stuff. How do you use the API?
- 163
5
votes
1
answer
734
views
Is it possible to authenticate a user through Stack Overflow API?
Is it possible to use the Stack Overflow API to authenticate a given user identity such as with Facebook, Twitter, or OpenID?
If it's possible: Can you tell me the method (s) that make this happen?
- 51
1
vote
1
answer
1k
views
5
votes
2
answers
161
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
1
vote
1
answer
85
views
user 'about_me' field suggested_buffer_size is too small
the suggested_buffer_size of user.about_me is currently 3000.
it is apparent that this is the server-side field length.
the problem is that the text is stored server-side in markdown but when served ...
- 12.1k
3
votes
1
answer
208
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
2
votes
1
answer
109
views
Error Code when API Key Limit exceeds
What will the error code be generated when API Key Limit exceeds? I need that because I have to handle this error in my application.
- 249
3
votes
2
answers
335
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 ...
- 303
3
votes
4
answers
283
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
12
votes
1
answer
362
views
How the /sites method is meant to be used
The /sites method is used to enumerate all sites in the network. If your [app] is meant to run against more than a single site (and many are) this method is how you should be discovering new sites in ...
4
votes
1
answer
146
views
AND searching for tags?
I am using the search api to search for questions that are tagged with "tags" and not with "tags". However I have noticed that searching for tags is an OR search.
The questions search for tags is an ...
- 465
9
votes
1
answer
1k
views
How to see which users upvoted a question?
I assume this information is tracked, since StackOverflow shows me the questions I have upvoted (when going to their question page, I can undo the upvote). I couldn't find any api call that gives this ...
- 1,079
4
votes
1
answer
110
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
2
votes
1
answer
89
views
Include range [1, 100] on pagesize
I see that "range" is being used to indicate valid range on most numeric parameters, e.g.
32-bit integer, range [0, 2,147,483,647]
32-bit integer, range [1, 2,147,483,647]
The smaller valid range ...
- 12.1k
3
votes
0
answers
52
views
API Help Suggestion: /search - can we make tagged,nottagged description consistent with other list params
on most other params that accept a semi-colon delimited list we see
list of tags questions must have, semicolon delimited
A single primary key identifier or a vectorized, semicolon-delimited list of ...
- 12.1k
1
vote
1
answer
89
views
/users/{id}/badges id parameter clarification
On /users/{id}/badges, the description of the id parameter
a semicolon delimited list of user ids
diverges from the inferred standard for multi-valued parameters:
A single primary key identifier or ...
- 12.1k
4
votes
2
answers
108
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.3k
0
votes
1
answer
98
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 ...
- 12.1k
2
votes
1
answer
117
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
1
vote
1
answer
80
views
`type=jsontext` JSON results for help pages
It would greatly simplify machine reading if we could apply type=jsontext to API help pages, including the index.
Update: Here's an unofficial JSON schema for v1.x.
- 12.1k
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 ...
- 12.1k
1
vote
1
answer
78
views
Please supply working example URLs for each route
It would take a lot of the guess work out of understanding the API if each route's page provided a small handful of working URLs.
This would also serve to provide authoritative examples of the ...
- 12.1k
1
vote
1
answer
40
views
help page issue: revisions by revisionguid example needed
/revisions/{id}/{revisionguid} - usage of this route is not clear to me.
can someone provide a working url and perhaps a simple use case.
- 12.1k
1
vote
1
answer
44
views
help page format issue: missing parameter
/users/{id}/tags is missing id parameter
fixing this will remove one more special case from my parser.
- 12.1k
1
vote
1
answer
57
views
help page format issue: revisionGuid
http://api.stackoverflow.com/0.8/help/method?method=revisions/{id}/{revisionguid}
revisionGuid is inconsistent.
revisionguid seems appropriate (and will remove one special case from my api parser).
- 12.1k
3
votes
1
answer
72
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 ...
1
vote
1
answer
77
views
Can we have all possible closed reasons in help page?
Can we have all possible closed_reasons in help page and if possible, closed_reason_id, too?
For example
closed_reason_id=1, closed_reason="exact duplicate",
closed_reason_id=2, closed_reason="off-...
- 5,022
1
vote
1
answer
62
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 ...
- 3,315
2
votes
2
answers
927
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,022
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
98
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
82
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
118
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
4
votes
2
answers
95
views
Document fields that may be not be included in responses
I'd like to see documentation on what fields may not be included in responses or, alternatively, which fields are guaranteed to be included. Currently it's a little confusing because some fields may ...
- 369
0
votes
1
answer
62
views
questions/{id}/timeline documentation: timeline_type values not listed
The timeline_type for post timelines just says "string" for the "values". From a cursory look at a few questions, I've seen the following types of events:
question
answer
comment
revision
votes
The ...
- 369
2
votes
1
answer
70
views
questions/{id} help page sort parameter description is inconsistence with others
The description of the Sort parameter in questions/{id} help page is inconsistent with those of other pages.
On the questions/{id} help page:
sort (optional):
How a collection
should be ...
- 5,022
5
votes
1
answer
142
views
Two minor typos in the API help
In http://api.stackoverflow.com/0.8/help
/users/{id}/answers Gets answer summary informatino for the user with 'id'.
and in the Returns section of http://api.stackoverflow.com/0.8/help/method?method=...
- 185
109
votes
3
answers
23k
views
API Documentation and Help
Method List
All API methods can be found at https://api.stackexchange.com/docs.
Global Method Parameters
All methods accept the following parameters:
type=jsontext: responds with mime-type text/json.
...