More feedback about the Search API section:

# Mentioning a user: http://search.twitter.com/search.atom?q=to%3Amzsanford

"to:user" in Search-land means that the tweet physically begins with
@user. This would be the stricter "reply" definition.  I would change
"Mentioning" to "Replies to a user" or "Strict Replies to a user"


# Referencing a user: http://search.twitter.com/search.atom?q=%40biz

"Referencing" should really be "Mentioning" here since that is in line
with the nomenclature of "mentions" in Twitter/REST-land.

# Combine any of the operators together:
http://search.twitter.com/search.atom?q="happy+hour"+near%3ASF

The Search API does *NOT* support the "near:location" operator (even
though the website does).  You must send in a geocoded lat/lang/radius
style argument in order to accomplish this with the API.  Ask Matt
about the official format.

# Originating from an application:
http://search.twitter.com/search.atom?q=landing from:tweetie

4 things:
1) searching for an application uses the "source:" operator, not "from:"
2) you should mention somewhere that you *cannot* just search for
tweets from a source, but that you must at least pass in some other
keyword to search along with the source: operator.
3) On a more general note, the spaces should be urlencoded as well.
It would probably help to mention somewhere in the doc that all
queries must be urlencoded before sending them.
4) For some reason the link in this example does not actually go to that query.
Other thoughts:

Where are the Optional Arguments like "since_id", "max_id", "rpp", and "page" ?

I believe I was told by Matt that queries are actually limited to 138
characters since it counts the "q=" characters in the request as part
of the query.  That should probably be noted.

I'll have a look at the REST sections later, but I don't exercise
those as heavily, so I might not be the best to review it.

-Chad

On Mon, Apr 13, 2009 at 7:11 PM, Doug Williams <[email protected]> wrote:
> Coderz,
> I am refactoring the API documentation [1] to make it friendlier on the eyes
> and easier on new developers. Please give it a once over and reply with any
> of errors, addition requests, or suggestions. We will be using these new
> docs officially in a few days (linked from the apiwiki.twitter.com) once any
> glaring omissions and/or errors are addressed.
>
> My goal is to make the documentation more robust and example laden to help
> new developers get going without needing help. Suggestions and critism along
> those lines is welcome.
>
> A final plea for help:
> If you have some spare time and examples to borrow from, please send
> [email protected] any code/instructions that I can then paste into method body
> to help new devs get started. Basic Hello World! style usage examples for
> each method would go a long way to curbing new developer problems. Be sure
> to include a link to any libraries your example is using. Working full
> length example code hosted on github would be preferred.
>
> 1. http://apiwiki.twitter.com/Twitter-API-Documentation
>
> Thanks,
> Doug Williams
> Twitter API Support
> http://twitter.com/dougw

Reply via email to