Friendships/show

«  Return to the list of API methods

URL

http://yourserver/api/friendships/show.format

Description

It returns information about the relationship between two users.

Available formats

XML, JSON

HTTP Method

GET

Requires authentication

YES

Required parameters

• source_screen_name: The username of the subject user. Example: http://yourserver/api/friendships/show.xml?source_screen_name=operador
• source_id: The ID of the subject user. Example: http://yourserver/api/friendships/show.json?source_id=1
• target_screen_name: The username of the target user. Example: http://yourserver/api/friendships/show.xml?target_screen_name=lorena
• target_id: The ID of the target user. Example: http://yourserver/api/friendships/show.json?target_id=2

Return example (XML)

curl http://yourserver/api/friendships/show.xml -G -d "source_screen_name=operador&target_screen_name=lorena"

<?xml version="1.0" encoding="UTF-8"?>
<relationship>
 <target>
  <followed_by type="boolean">false</followed_by>
  <following type="boolean">false</following>
  <screen_name>lorena</screen_name>
  <id type="integer">2</id>
 </target>
 <source>
  <followed_by type="boolean">false</followed_by>
  <following type="boolean">false</following>
  <screen_name>operador</screen_name>
  <id type="integer">1</id>
  <notifications_enabled type="boolean">false</notifications_enabled>
  <blocking type="boolean">false</blocking>
 </source>
</relationship>

Return example (JSON)

curl http://yourserver/api/friendships/show.json -G -d "source_screen_name=operador&target_screen_name=lorena"

{
    "relationship": {
        "target": {
            "followed_by": false,
            "following": false,
            "screen_name": "lorena",
            "id": 2
        },
        "source": {
            "followed_by": false,
            "following": false,
            "screen_name": "operador",
            "id": 1,
            "notifications_enabled": false,
            "blocking": false
        }
    }
}