/snapshot/votes/search

POST /api/snapshot/votes/search

Price: 1 credit

Search and list Snapshot votes by proposal, voter address, or space

How to use it

Search and list individual Snapshot votes. Filter by a proposal id to get every vote cast on one proposal, by one or more voter addresses to get a voter's history, or by space; optionally narrow by a created-time range. Sort by created time or voting power. Each vote includes the voter address, the choice made, the voting power (total and per strategy), an optional reason, and the proposal and space it belongs to.

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 votes to return (min: 1)
• proposal string nullable — Filter by proposal id (all votes cast on one proposal) (minLength: 1)
• proposal_in array nullable — Filter by several proposal ids at once
• voter array nullable — Filter by one or more voter wallet addresses (a voter's voting history)
• space string nullable — Filter by space id (examples: "ens.eth")
• created_after integer nullable — Only votes cast after this unix timestamp
• created_before integer nullable — Only votes cast before this unix timestamp
• vp_min number nullable — Only votes with voting power greater than this
• vp_max number nullable — Only votes with voting power less than this
• order string — Sort field (default: "created"; one of: "created", "vp")
• ascending boolean — Sort ascending instead of descending (default: false)

Response

• @type string (default: "SnapshotVote")
• id string required
• ipfs string nullable
• voter string nullable
• choice union nullable
• reason string nullable
• vp number nullable
• vp_value number nullable
• vp_by_strategy array (default: [])
• vp_state string nullable
• metadata object nullable
• proposal object nullable
  • @type string (default: "SnapshotProposalRef")
  • id string required
  • state string nullable
• space object nullable
  • @type string (default: "SnapshotSpaceRef")
  • id string required
  • name string nullable
  • image string nullable
  • network string nullable
• created_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.