profile.get

Description

Returns general status information for a nominated user.

Parameters

Required

Name Type Description
oauth_consumer_key String Your API key when you registered as a developer
oauth_signature_method String The method used to generate the signature (only HMAC-SHA1 is supported)
oauth_timestamp Int The date and time, expressed in the number of seconds since January 1, 1970 00:00:00 GMT. The timestamp value must be a positive integer and must be equal or greater than the timestamp used in previous requests
oauth_nonce String A randomly generated string for a request that can be combined with the timestamp to produce a unique value
oauth_version String MUST be "1.0"
oauth_signature String The signature, a consistent reproducible concatenation of the request elements into a single string. The string is used as an input in hashing or signing algorithms.
method String MUST be "profile.get"
oauth_token String The key of the profile to use.

Optional

Name Type Description
format String The desired response format. Valid reponse formats are "xml" or "json" (default value is "xml").

Response

The profile element returned contains general information about the nominated user as follows:

  • weight_measure – either "kg" or "lb" - whether weight should be displayed in kilograms or pounds - see weight_type
  • height_measure – either "cm" or "inch" - whether height should be displayed in centimeters or inches - see height_type
  • last_weight_kg is a Decimal - the last recorded weight in kilograms
  • last_weight_date_int is an Int – the date that the user's weight was last recorded, see dateint
  • last_weight_comment – the comment recorded by the user on the last weight entry (where available)
  • goal_weight_kg is a Decimal – the user's goal weight in kilograms
  • height_cm is a Decimal – the user's current height in centimeters

Example Return XML

<?xml version="1.0" encoding="utf-8" ?>
<profile xmlns="http://platform.fatsecret.com/api/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://platform.fatsecret.com/api/1.0/ http://platform.fatsecret.com/api/1.0/fatsecret.xsd">
    <weight_measure>Kg</weight_measure>
    <height_measure>Cm</height_measure>
    <last_weight_kg>80.0000</last_weight_kg>
    <last_weight_date_int>14289</last_weight_date_int>
    <last_weight_comment>Woohoo!</last_weight_comment>
    <goal_weight_kg>78.0000</goal_weight_kg>
    <height_cm>187.96</height_cm>
</profile>

Example Return JSON

{ "profile": {"goal_weight_kg": "78.0000", "height_cm": "187.96", "height_measure": "Cm", "last_weight_comment": "Woohoo!", "last_weight_date_int": "14289", "last_weight_kg": "80.0000", "weight_measure": "Kg" }}

Error Code

Code Description
2 Missing required oauth parameter: "<detail>"
3 Unsupported oauth parameter: "<detail>"
4 Invalid signature method: "<detail>"
5 Invalid consumer key: "<detail>"
6 Invalid/expired timestamp: "<detail>"
7 Invalid/used nonce: "<detail>"
8 Invalid signature: "<detail>"
9 Invalid access token: "<detail>"
FatSecret Sites
For Developers

For Professionals

For Everyone

FatSecret Platform API

Support
API

About FatSecret

© 2021 FatSecret. All rights reserved.