Help / API

user.get / Live testing

Get information about a user

This method call does not require authentication.
This method does not require any particular permission.

URL

http://www.ipernity.com/api/user.get

Parameters

`api_key`	∗	Your api_key.
`user_id`	∗	The User ID (or User Alias) to get information about.

∗ : this parameter is required.

Response

<user user_id="12345" is_pro="0" is_online="0" is_closed="0" tmo="-3600"
      username="Superman" realname="Kal-El" alias="superman"
      icon="http://u1.ipernity.com/p/AA/12/12345/userphoto.jpg"
      link="http://www.ipernity.com/home/superman">
  <relation isfamily="0" isfriend="1" iscontact="0" revfamily="1" revfriend="1" revcontact="0"/>
  <location country="USA" town="Smallville" lat="43.271221739661" lng="5.3876996040344" />
  <count docs="1235" posts="25" network="32"/>
</user>

The flag user.is_closed="1" means the user account is desactivated or temporarily closed by ipernity moderation team.
The realname value is subject to privacy settings and may not always be displayed.

Error codes

1	`User not found`	The user ID is either invalid or the account is closed/suspended.

100	`API Key is missing`	Please add the api_key parameter to this request.
101	`API Key is invalid`	This API key is invalid or disabled.
102	`Invalid format`	The requested format is invalid. Valid formats are : json, xml, php.
103	`Method not found`	The requested method is invalid or missing.
104	`Signature missing`	The query signature is missing.
105	`Signature is invalid`	The query signature is invalid.
106	`Token missing`	User is not logged. The authentication token is missing.
107	`Token invalid`	The authentication token is invalid.
108	`Account closed`	The user account is closed or suspended.
109	`Action blocked`	This action is blocked because of a member or a group blocklist restriction
110	`Insufficient permissions`	Insufficient permissions for this method.
111	`IP not allowed`	The request came from a remote address not allowed by this application.
112	`Application Quota Error`	The application has reached its requests quota.
113	`Client IP Quota Error`	The client IP has reached a limit. Limits are based on requests per seconds, minutes, hours, ...
120	`HTTP POST required`	This API method must be called using HTTP POST.
121	`Invalid SOAP envelope`	The SOAP envelope could not be parsed.
122	`Invalid XML-RPC envelope`	The XML-RPC envelope could not be parsed.
500	`Service error`	Service general error.
501	`Maintenance mode`	Service under temporarily maintenance. Thank you for your kind understanding.
503	`Service unavailable`	The service is temporarily unavailable. Please try again in a few minutes.

Changelog

2008-12-01: Method created.