Users/search

«  Return to the list of API methods

Contents

URL

http://yourserver/api/users/search.format

Description

It returns complete info about users which mach the provided query

Available formats

XML, JSON

HTTP Method

GET

Requires authentication

NO

Required parameters

Return example (XML)

curl http://yourserver/api/users/search.xml?q=m
<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
 <user>
  <id>1</id>
  <name>marcosgdf</name>
  <screen_name>marcosgdf</screen_name>
  <location/>
  <description/>
  <profile_image_url>http://localhost/trunk/static/img/avatar/default_note.png</profile_image_url>
  <url/>
  <protected>true</protected>
  <followers_count>0</followers_count>
  <created_at>Fri Apr 16 20:12:11 +0000 2010</created_at>
  <favourites_count>0</favourites_count>
  <statuses_count>4</statuses_count>
  <friends_count>1</friends_count>
  <following>false</following>
  <utc_offset/>
  <geo_enabled>false</geo_enabled>
  <time_zone/>
  <profile_background_image_url>http://localhost/trunk/themes/transparency/img/bg.png</profile_background_image_url>
  <profile_background_tile>false</profile_background_tile>
  <notifications>false</notifications>
  <verified>false</verified>
  <lang>default</lang>
  <contributors_enabled>false</contributors_enabled>
  <status>
   <created_at>Sat Apr 17 12:59:51 +0000 2010</created_at>
   <id>32</id>
   <text>aham</text>
   <source>api</source>
   <truncated>false</truncated>
   <in_reply_to_status_id/>
   <in_reply_to_user_id/>
   <favorited>false</favorited>
   <in_reply_to_screen_name/>
  </status>
 </user>
</users>

Return example (JSON)

curl http://yourserver/api/users/search.json?q=m
[
    {
        "id": 1,
        "name": "marcosgdf",
        "screen_name": "marcosgdf",
        "location": null,
        "description": "",
        "profile_image_url": "http:\/\/localhost\/trunk\/static\/img\/avatar\/default_note.png",
        "url": null,
        "protected": true,
        "followers_count": "0",
        "created_at": "Fri Apr 16 20:12:11 +0000 2010",
        "favourites_count": 0,
        "statuses_count": "4",
        "friends_count": "1",
        "following": false,
        "utc_offset": null,
        "time_zone": null,
        "profile_background_image_url": "http:\/\/localhost\/trunk\/themes\/transparency\/img\/bg.png",
        "profile_background_tile": false,
        "notifications": false,
        "verified": false,
        "lang": "default",
        "contributions_enabled": false,
        "geo_enabled": false,
        "status": {
            "created_at": "Sat Apr 17 12:59:51 +0000 2010",
            "id": "32",
            "source": "api",
            "truncated": false,
            "in_reply_to_status_id": null,
            "in_reply_to_user_id": null,
            "favorited": false,
            "in_reply_to_screen_name": null,
            "text": "aham"
        }
    }
]