LiquidFeedback API initiative
To request the preliminary initiative api, call <BASEURL>/api/initiative.html with the following arguments as HTTP GET parameters. For example call
http://example.com/liquidfeedback/api/initiative.html?key=MYSECRETAPIKEYFORLQFB&api_engine=json&min_id=23 to get all initiatives with an id greater or equal 23 in json encoding. Intervals are encoded according to PostgreSQL standard interval output formatting, see PostgreSQL manual section 8.5.5 for details.
Request parameters (HTTP GET parameters)
key [MANDATORY]
Your personal API key, request it under "Settings" → "Developer settings" in LiquidFeedback.
api_engine
The format for encoding the answer of the request. Valid options are "json" and "xml". Defaults to "xml".
id
Return only initiative matching this id
min_id
Return only initiative with id >= min_id
max_id
Return only initiative with id ⇐ max_id
area_id
Return only initiative for specific area
issue_id
Return only initiative for specific issue
policy_id
Return only initiatives having specific policy
state
Return only initiatives having specific state. Valid values area "new", "accepted", "frozen", "voting", "finished" and "cancelled".
agreed
If set, return only initiatives which are agreed (winner).
limit
Limit how many results should be delivered.
order
How to order the result set. Currently per default by "id", other valid options are "supporter_count" and "id_desc".
render_draft
If set to html, current_draft_content will be delivered as html fragment instead of wiki text.
Attributes of the resulting initiatives
area_id [integer]
Id of the area
area_name [string]
Name of the area
issue_id [integer]
Id of the issue
issue_state [string]
Current state of the issue, valid values are: new accepted frozen voting finished cancelled.
issue_created [timestamp]
Point in time, when the issue has been created.
issue_accepted [timestamp]
Point in time, when one initiative of issue reached the "issue_quorum"
issue_half_frozen [timestamp]
Point in time, when "discussion_time" has elapsed, or members voted for voting.
issue_fully_frozen [timestamp]
Point in time, when "verification_time" has elapsed.
issue_closed [timestamp]
Point in time, when "admission_time" or "voting_time" have elapsed, and issue is no longer active.
issue_admission_time [interval]
Maximum time an issue stays open without being "accepted"
issue_discussion_time [interval]
Regular time until an issue is "half_frozen" after being "accepted"
issue_verification_time [interval]
Regular time until an issue is "fully_frozen" after being "half_frozen"
issue_voting_time [interval]
Time after an issue is "fully_frozen" but not "closed"
issue_population [integer]
Number of members interested in this issue.
issue_vote_now [integer]
Number of votes in fravor of voting now.
issue_vote_later [integer]
Number of votes against voting now.
issue_voter_count [integer]
Total number of direct and delegating voters; This value is related to the final voting, while "population" is related to snapshots before the final voting.
issue_ranks_available [boolean]
TRUE = ranks have been calculated
policy_issue_quorum_num [integer]
policy_issue_quorum_den [integer]
Numerator and denumerator of potential supporter quorum to be reached by one initiative of an issue to be "accepted".
policy_initiative_quorum_num [integer]
policy_initiative_quorum_den [integer]
Numerator and denumerator of satisfied supporter quorum to be reached by an initiative to be "admitted" for voting.
policy_majority_num [integer]
policy_majority_den [integer]
Numerator and denumerator of fraction of majority to be reached during voting by an initiative to be aggreed upon.
policy_majority_strict [boolean]
If TRUE, then the majority must be strictly greater than "majority_num"/"majority_den", otherwise it may also be equal.
id [integer]
Id of the initiative.
name [string]
Name (title) of the iniative.
discussion_url [string]
URL to discussion page of the initiators.
created [timestamp]
Timestamp of initiative creation.
revoked [timestamp]
Timestamp of initiative revokation. Empty if initiative isn't revoked.
suggested_initiative_id [integer]
The id of the initiative suggested by the initiators of a revoked initiative. Empty if not revoked or none suggested.
admitted [boolean]
TRUE, if initiative reaches the "initiative_quorum" when freezing the issue.
supporter_count [integer]
Number of members currently supporting the initiative.
informed_supporter_count [integer]
Number of members currently supporting the latest draft of the initiative.
satisfied_supporter_count [integer]
Number of members currently supporting the initiative and not having critical opinion.
satisfied_informed_supporter_count [integer]
Number of members currently supporting the latest draft of the initiative and not having critical opinion.
positive_votes [integer]
Number of positive votes for this initiative. Only available in issue state finished.
negative_votes [integer]
Number of negative votes for this initiative. Only available in issue state finished.
agreed [boolean]
TRUE if "positive_votes"/("positive_votes"+"negative_votes") is strictly greater or greater-equal than initiative quorum.
rank [integer]
Rank of approved initiatives (winner is 1).
current_draft_created [timestamp]
Point in time, when the initiative draft was last updated.
current_draft_formatting_engine [string]
The wiki formatting engine used for the current draft version.
current_draft_content [string]
The current draft itself.