/snapshot/proposals/search

POST /api/snapshot/proposals/search

Price: 5 credits

Search and list Snapshot governance proposals by keyword, space, author, state, type and date ranges

How to use it

Search and list Snapshot off-chain governance proposals. Match a keyword against the proposal title, and filter by space ids, author addresses, lifecycle state (active, pending, closed), voting type, network, flagged status, score state, and created/start/end date ranges; sort by created, start, end, vote count, or total score. Each proposal includes the title, body text, choices, scores, voting type, state, quorum, strategies, space, author address, vote count, and timestamps.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of proposals to return (min: 1)
• query string nullable — Keyword to match against the proposal title (examples: "treasury"; minLength: 1)
• space array nullable — Filter by one or more space ids (examples: ["ens.eth"], ["aave.eth","uniswapgovernance.eth"])
• state string — Filter by proposal lifecycle state (default: "all"; one of: "active", "pending", "closed", "all")
• author array nullable — Filter by one or more author wallet addresses
• type string nullable — Filter by voting type (one of: "single-choice", "approval", "quadratic", "ranked-choice", "weighted", "basic")
• network string nullable — Filter by network chain id (examples: "1", "137", "42161")
• flagged boolean nullable — Filter by flagged (spam) status
• scores_state string nullable — Filter by score computation state (one of: "pending", "final", "invalid")
• created_after integer nullable — Only proposals created after this unix timestamp
• created_before integer nullable — Only proposals created before this unix timestamp
• start_after integer nullable — Only proposals whose voting starts after this unix timestamp
• start_before integer nullable — Only proposals whose voting starts before this unix timestamp
• end_after integer nullable — Only proposals whose voting ends after this unix timestamp
• end_before integer nullable — Only proposals whose voting ends before this unix timestamp
• order string — Sort field (default: "created"; one of: "created", "start", "end", "votes", "scores_total")
• ascending boolean — Sort ascending instead of descending (default: false)

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 — The entity was not found, or a precondition failed 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.