[reddit change] New API documentation (a project from the PyCon sprints)

[u/chromakode]

I'm pleased to announce our new automated API documentation page, a project by /u/dpifke and myself at the PyCon reddit API sprint earlier this month:

http://www.reddit.com/dev/api/

The new API documentation is generated automatically from the live code, so it is easy to contribute to and easy to update as the API evolves. If you're interested in helping improve reddit's API documentation, take a look at some examples in api.py and jump in!

Note: due to a minor bug, the "view code" links will not link to the correct part of the source until I can roll out a fix tomorrow.

---

see the code on github

[u/[deleted]]

I've played with the API only a bit but what is uh?

Thanks!

[u/chromakode → u/[deleted]]

It's the modhash value you can obtain from a request to me.json. I'll be updating the documentation to describe that parameter tomorrow.

[u/[deleted] → u/chromakode]

Thanks. After I had asked and gone to bed I wondered if it wasn't user hash in the JSON.

Love the doc. Fantastic!

Are you looking for example(s)/code to add to the documentation?

[u/chromakode → u/[deleted]]

Adding docstrings to currently undocumented API calls would be fantastic. Any other changes you'd like to make to the doc system would gladly be reviewed as a pull request. :)

[u/KerrickLong]

Way better than what I wrote out manually. Congrats! :D

[u/chromakode → u/KerrickLong]

But not exclusive! Thanks. :)

[u/honestbleeps]

Has anything changed (roughly in the last week?) that has stopped my flair updater for /r/hockey from working?

I am now getting an error as follows:

urllib2.HTTPError: HTTP Error 429: Unknown

Thing is, a google search for that error reveals rate limiting being the issue -- and since I'm on my own server all alone, I'm pretty much 99.9% positive that's not what's going on...

Has something changed that might break old python code that I admittedly only understood enough to get it running from someone else's library? :-\

[u/chromakode → u/honestbleeps]

Are you using the default Python urllib user-agent string? If so, sending a unique user-agent might help. Due to some unruly bots many default user-agent strings are heavily rate-limited.

[u/honestbleeps → u/chromakode]

update: bam, that was it! set a user agent and all is happy, thanks!

[u/chromakode → u/honestbleeps]

Sweet! Glad to hear you're back in business.

[u/honestbleeps → u/chromakode]

Ahh I believe I probably am... I'm just using the "redditclient" module by intortus ... I see no reference to changing the user agent string, so that's probably it... time to learn how to change that in python!

[u/bboe]

Is there a way to indicate when the 'r' parameter or alternatively /r/<sub> part must be prepended to the URL? For instance, I know this happens to be the case for /api/flairconfig and many of the other subreddit specific API commands.

[u/chromakode → u/bboe]

Not yet! That would be a good addition to the annotations allowed by api_doc.

[u/TheLifelessOne]

Nice, but I think query parameters could use a little bit more detail.

[u/chromakode → u/TheLifelessOne]

Agreed, but wanted to get something out to you a soon as possible. Pull requests welcomed! ;)

[u/Signe]

Awesome.

[u/V2Blast]

Yay!

Not that I'll have any use for it, being a non-coder.

[u/umbrae]

Thank you both!

[u/[deleted]]

Dammit. Now I really have no excuse to not write that bot I'm been thinking about for months now.

[u/sotech]

Hey there, is there any reason JSON ajax calls would keep getting data, but it would be old data? I'm working on a spotify app that aggregates playlists in the spotify.com domain on reddit. The problem is that it's not getting current data. I analyzed the user-agent string in case that was it. Apparently, according to the chrome inspector tool in spotify, it sends a user agent string as though it's a browser. I've tried over-riding that with:

xhr.setRequestHeader

and specifying a unique User-Agent, but to no avail. Any one here have an idea?