Document all the API parameters

Can the API documentation be updated with all parameters?

Only through following the 'example API call' link did I stumble upon the 'pretty' (prettyprint) parameter.

Are there any other general parameters?

Answer this question I have this problem too

Is this a good question?

Score 2
Add a comment

1 Answer

Most Helpful Answer

We've been working hard on an update to the API, 1.0. It should be out soon (I think in a few weeks). It's basically done, but we haven't posted it yet because we've been running it past a few developers to get feedback.

Here's the documentation for the 1.0 API. It's a bit better documented than 0.1 and adds support for video, which is coming down the pike.

We added ?pretty as a convenience for ourselves—all it does is add whitespace to the JSON response so it's easier to read. (No program calling the API would want to use it.) But I reckon you're right, it can be mighty convenient and we should mention it in the docs. I'll do that.

Was this answer helpful?

Score 2

Comments:

Ah, excellent, I see it's already mentioned in the 1.0 API docs. Thanks!

prettyprint is actually fairly common in APIs. While no program may want to use it (other than naive line-by-line parsers), programmers themselves certainly enjoy being able to quickly check output that isn't a run-on line. ( There's services online that will prettyprint out - it just saves the extra step. )

by

Add a comment

Add your answer

Steven will be eternally grateful.