/snapshot/proposals

POST /api/snapshot/proposals

Price: 1 credit

Get a Snapshot governance proposal by its id

How to use it

Get a single Snapshot off-chain governance proposal by its id (hash). Returns the title, full body text, voting choices, current scores per choice and total, voting type, lifecycle state (active, pending, closed), quorum, the voting strategies used, the space it belongs to, author address, discussion link, vote count, and start/end/created timestamps.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• proposal string required — Proposal id (hash) (examples: "0x3c5d6f9f9b3f0e2c1f4f5e6d7c8b9a0f1e2d3c4b5a6978899aabbccddeeff0011"; minLength: 1)

Response

• @type string (default: "SnapshotProposal")
• id string required
• ipfs string nullable
• author string nullable
• space object nullable
  • @type string (default: "SnapshotSpaceRef")
  • id string required
  • name string nullable
  • image string nullable
  • network string nullable
• text string nullable
• discussion_url string nullable
• web_url string nullable
• app string nullable
• type string nullable
• state string nullable
• privacy string nullable
• network string nullable
• symbol string nullable
• choices array (default: [])
• quorum number nullable
• quorum_type string nullable
• snapshot_block string nullable
• scores array (default: [])
• scores_by_strategy array (default: [])
• scores_total number nullable
• scores_total_value number nullable
• vp_value_by_strategy array (default: [])
• scores_state string nullable
• scores_updated_at integer nullable
• vote_count integer nullable
• is_flagged boolean nullable
• strategies array (default: [])
  • @type string (default: "SnapshotStrategyRef")
  • name string required
  • network string nullable
  • params object nullable
• validation object nullable
  • @type string (default: "SnapshotSpaceValidation")
  • name string required
  • params object nullable
• plugins object nullable
• created_at integer nullable
• updated_at integer nullable
• start_at integer nullable
• end_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Proposal not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.