Last 7 days, UTC

Average Latency
54ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Query Authentication
 

See https://www.beeminder.com/api#auth to get your auth token. This authentication pattern is for making API calls just to your own Beeminder account.


Authentication
Description
Parameter
String

username on beeminder

username

Required

String

authentication token associated with username (https://www.beeminder.com/api/v1/auth_token.json)

auth_token

Required

Endpoints

HTTP 200 : string POST/users/{u}/goals/{g}/cancel_stepdown.json
Cancel a scheduled step down

Cancel a pending stepdown of a goal's project


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

HTTP 200 : string POST/users/{u}/goals/{g}/stepdown.json
Step down a goal’s pledge

Decrease the goal’s pledge level subject to the akrasia horizon, i.e., not immediately. After a successful request the goal will have a countdown to when it will revert to the lower pledge level.


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

HTTP 200 : string POST/users/{u}/goals/{g}/dial_road.json
Update a yellow brick road

Change the slope of the yellow brick road (starting after the one-week Akrasia Horizon) for beeminder.com/u/g.


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

number

The slope of the (final section of the) yellow brick road.

rate

Required

number

Unix timestamp (in seconds) of the goal date.

goaldate

Required

string

Goal value — the number the yellow brick road will eventually reach. E.g., 70 kilograms.

goalval

Optional

Charge Resource

HTTP 200 : string POST/charges
Create a charge

Create a charge of a given amount and optionally add a note.


Test console
Description
Parameter
number

The amount to charge the user, in US dollars.

amount

Optional

string

An explanation of why the charge was made.

note

Optional

string

If passed, the Charge is not actually created, but the JSON for it is returned as if it were. Default: false.

dryrun

Optional

Datapoint Resource

HTTP 200 : string POST/users/{u}/goals/{g}/datapoints.json
Create a datapoint

Add a new datapoint to user u’s goal g — beeminder.com/u/g.


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

number

The unix time (in seconds) of the datapoint.

timestamp

Optional

number

The value, e.g., how much you weighed on the day indicated by the timestamp.

value

Required

string

An optional comment about the datapoint.

comment

Required

boolean

Indicates whether to email the user when the graph has updated with the new datapoint. Default: false.

sendmail

Required

string

If a datapoint was created via the API and this parameter was included, it will be echoed back.

requestid

Required

HTTP 200 : string POST/users/{u}/goals{g}/datapoints/create_all.json
Create multiple datapoints

Create multiple new datapoints for beeminder.com/u/g.


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

string

Each must include timestamp, value, and comment, with requestid optional.

datapoints

Required

boolean

Indicates whether to email the user when the graph has updated with the new datapoint. Default: false.

sendmail

Required

HTTP 200 : string DELETE/users/{u}/goals/{g}/datapoints/{id}.json
Delete a datapoint

Delete the datapoint with ID id for user u’s goal g (beeminder.com/u/g).


Test console
Description
Parameter
string

user u

u

Required

string

id for user

id

Required

string

goal g

g

Required

HTTP 200 : string GET/users/{u}/goals/{g}/datapoints.json
Get all the datapoints

Get the list of datapoints for user u’s goal g — beeminder.com/u/g.


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

HTTP 200 : string PUT/users/{u}/goals/{g}/datapoints/id.json
Update a datapoint

Update the datapoint with ID id for user u’s goal g (beeminder.com/u/g).


Test console
Description
Parameter
string

user name

u

Required

string

user goal

g

Required

number

The unix time (in seconds) of the datapoint.

timestamp

Optional

number

The value, e.g., how much you weighed on the day indicated by the timestamp.

value

Optional

string

An optional comment about the datapoint.

comment

Optional

Goal Resource

HTTP 200 : string POST/users/{username}/goals.json
Create a goal for a user

Create a new goal for user u.


Test console
Description
Parameter
string

he Beeminder username of the user being charged.
Example: alice

username

Required

string

The final part of the URL of the goal, used as an identifier. E.g, if user “alice” has a goal at beeminder.com/alice/weight then the goal’s slug is “weight”.

slug

Required

string

The title that the user specified for the goal. E.g., “Weight Loss”.
Example: Work Out More

title

Required

string

One of the following symbols: hustler, biker, fatloser, gainer, inboxer, drinker, custom
Example: hustler

goal_type

Required

string

Unix timestamp (in seconds) of the goal date.

goaldate

Required

number

Goal value — the number the yellow brick road will eventually reach. E.g., 70 kilograms.
Example: null

goalval

Optional

number

The slope of the (final section of the) yellow brick road.

rate

Required

string

The y-value of the start of the yellow brick road.
Example: 1400000000

initval

Required

boolean

Whether the graph was created in test mode. (Test mode goals are periodically garbage-collected.)

ephem

Required

string

Panic threshold. How long before derailment to panic. Default: 54000 (15 hours).

panic

Required

string

Whether you have to be signed in as owner of the goal to view it. Default: false.

secret

Required

string

Whether you have to be signed in as the owner of the goal to view the datapoints. Default: false.

datapublic

Required

HTTP 200 : string GET/users/{username}/goals.json
Get all goals for a user

Get user u’s list of goals.


Test console
Description
Parameter
string

The Beeminder username of the user being charged.

username

Required

string

One of {all, frontburner, backburner}. Default: all.

filter

Required

HTTP 200 : Get information about a goal Model GET/users/{username}/goals/{goal}.json
						{
  "errors": {
    "message": "Authorization error: bad token, missing token, or wrong kind of token.",
    "token": "bad_token"
  }
}						
Get information about a goal

Gets goal details for user u’s goal g — beeminder.com/u/g.


Test console
Description
Parameter
string

Since appending an access_token to the request uniquely identifies a user, you can alternatively make the request to /users/me.json (without the username).
Example: alice

username

Required

string

Goal of user
Example: weight

goal

Required

boolean

Whether to to send the goal’s datapoints in the response. Default: false.

datapoints

Required

HTTP 200 : string POST/users/{u}/ goals/{g}/shortcircuit.json
Short circuit a goal's pledge

Increase the goal’s pledge level and charge the user the amount of the current pledge.


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

HTTP 200 : string PUT/users/{u}/goals/{g}.json
Update a goal for a user

Update user u’s goal g. This is similar to the call to create a new goal, but the goal type (goal_type) cannot be changed. To change any of {goaldate, goalval, rate} use the dial_road call below.


Test console
Description
Parameter
string

user u

u

Required

string

goal g

g

Required

string

The final part of the URL of the goal, used as an identifier. E.g, if user “alice” has a goal at beeminder.com/alice/weight then the goal’s slug is “weight”.

slug

Optional

string

he title that the user specified for the goal. E.g., “Weight Loss”.

title

Optional

boolean

Whether the graph was created in test mode. (Test mode goals are periodically garbage-collected.)

ephem

Optional

number

Whether the graph is currently being updated to reflect new data.

panic

Optional

boolean

Whether you have to be signed in as owner of the goal to view it. Default: false.

secret

Optional

boolean

Whether you have to be signed in as the owner of the goal to view the datapoints. Default: false.

datapublic

Optional

User Resource

HTTP 200 : Get information about a user Model GET/users/{username}.json
						{
  "errors": {
    "message": "Authorization error: bad token, missing token, or wrong kind of token.",
    "token": "bad_token"
  }
}						
Get information about a user

Retrieves information and a list of goal names for the user with username u.


Test console
Description
Parameter
string

Since appending an access_token to the request uniquely identifies a user, you can alternatively make the request to /users/me.json (without the username).
Example: mirajr

username

Required

string

One of {all, frontburner, backburner}. Default: all, which returns an unfiltered list of all goals. Send frontburner if you want the list of goals the user has marked as frontburner goals (those which appear above the fold in the web interface), or backburner for just the below-the-fold goals.

goals_filter

Optional

boolean

Convenience method to fetch all information about a user. Please use sparingly and see also the diff_since parameter. Default: false Send true if you want to receive all of the user’s goal and datapoints as attributes of the user object.

associations

Optional

number

Unix timestamp in seconds. Default: null, which will return all goals and datapoints Send a Unix timestamp to receive a filtered list of the user’s goals and datapoints. Only goals and datapoints that have been created or updated since the timestamp will be returned. Sending diff_since implies that you want the user’s associations, so you don’t need to send both.

diff_since

Optional

boolean

Convenience method to only get a subset of goal attributes and the most recent datapoint for the goal. Default: false, which will return all goal attributes and all datapoints created or updated since diff_since. skinny must be sent along with diff_since. If diff_since is not present, skinny is ignored. Some goal attributes, as well as fetching all datapoints, can take some additional time to compute on the server side, so you can send skinny if you only need the latest datapoint and the following subset of attributes: slug, title, goalval, rate, goaldate, graph_url, thumb_url, goal_type, losedate, id, ephem, queued, panic, updated_at, burner, yaw, runits, lane, frozen, won, lost Instead of a datapoints attribute, sending skinny will replace that attribute with a last_datapoint attribute. Its value is a Datapoint hash.

skinny

Optional

number

number of datapoints. Default: null, which will return all goals and datapoints Send a number n to only recieve the n most recently added datapoints, sorted by updated_at. Note that the most recently added datapoint could have been a datapoint whose timestamp is well in the past and therefore before other datapoints in that respect.

datapoints_count

Optional

Consume this API completely for free!


By joining the mashape API marketplace you can start using Beeminder API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.