--- updatedAt: 2025-06-11T20:37:27.000Z agentTools: projectIndex: https://docs.allthatnode.com/llms.txt --- # Proposals queries all proposals based on given status. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Cosmos SDK - gRPC Gateway docs", "description": "A REST interface for state queries.", "version": "1.0.0" }, "paths": { "/cosmos/gov/v1/proposals": { "get": { "summary": "Proposals queries all proposals based on given status.", "operationId": "GovV1Proposal", "responses": { "200": { "description": "A successful response.", "content": { "*/*": { "schema": { "type": "object", "properties": { "proposals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64", "description": "id defines the unique id of the proposal." }, "messages": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." } }, "additionalProperties": {}, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" }, "description": "messages are the arbitrary messages to be executed if the proposal passes." }, "status": { "description": "status defines the proposal status.", "type": "string", "enum": [ "PROPOSAL_STATUS_UNSPECIFIED", "PROPOSAL_STATUS_DEPOSIT_PERIOD", "PROPOSAL_STATUS_VOTING_PERIOD", "PROPOSAL_STATUS_PASSED", "PROPOSAL_STATUS_REJECTED", "PROPOSAL_STATUS_FAILED" ], "default": "PROPOSAL_STATUS_UNSPECIFIED" }, "final_tally_result": { "description": "final_tally_result is the final tally result of the proposal. When\nquerying a proposal via gRPC, this field is not populated until the\nproposal's voting period has ended.", "type": "object", "properties": { "yes_count": { "type": "string", "description": "yes_count is the number of yes votes on a proposal.\n\noption 1" }, "abstain_count": { "type": "string", "description": "abstain_count is the number of abstain votes on a proposal.\n\noption 2" }, "no_count": { "type": "string", "description": "no_count is the number of no votes on a proposal.\n\noption 3" }, "no_with_veto_count": { "type": "string", "description": "no_with_veto_count is the number of no with veto votes on a proposal.\n\noption 4" }, "option_one_count": { "type": "string", "description": "option_one_count corresponds to the number of votes for option one (= yes_count for non multiple choice proposals)." }, "option_two_count": { "type": "string", "description": "option_two_count corresponds to the number of votes for option two (= abstain_count for non multiple choice\nproposals)." }, "option_three_count": { "type": "string", "description": "option_three_count corresponds to the number of votes for option three (= no_count for non multiple choice\nproposals)." }, "option_four_count": { "type": "string", "description": "option_four_count corresponds to the number of votes for option four (= no_with_veto_count for non multiple choice\nproposals)." }, "spam_count": { "type": "string", "description": "spam_count is the number of spam votes on a proposal." } } }, "submit_time": { "type": "string", "format": "date-time", "description": "submit_time is the time of proposal submission." }, "deposit_end_time": { "type": "string", "format": "date-time", "description": "deposit_end_time is the end time for deposition." }, "total_deposit": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "Coin defines a token with a denomination and an amount.\n\nNOTE: The amount field is an Int which implements the custom method\nsignatures required by gogoproto." }, "description": "total_deposit is the total deposit on the proposal." }, "voting_start_time": { "type": "string", "format": "date-time", "description": "voting_start_time is the starting time to vote on a proposal." }, "voting_end_time": { "type": "string", "format": "date-time", "description": "voting_end_time is the end time of voting on a proposal." }, "metadata": { "type": "string", "title": "metadata is any arbitrary metadata attached to the proposal.\nthe recommended format of the metadata is to be found here:\nhttps://docs.cosmos.network/v0.47/modules/gov#proposal-3" }, "title": { "type": "string", "title": "title is the title of the proposal" }, "summary": { "type": "string", "title": "summary is a short summary of the proposal" }, "proposer": { "type": "string", "title": "proposer is the address of the proposal sumbitter" }, "expedited": { "type": "boolean", "description": "Deprecated: Use ProposalType instead.", "title": "expedited defines if the proposal is expedited" }, "failed_reason": { "type": "string", "title": "failed_reason defines the reason why the proposal failed" }, "proposal_type": { "title": "proposal_type defines the type of the proposal", "type": "string", "enum": [ "PROPOSAL_TYPE_UNSPECIFIED", "PROPOSAL_TYPE_STANDARD", "PROPOSAL_TYPE_MULTIPLE_CHOICE", "PROPOSAL_TYPE_OPTIMISTIC", "PROPOSAL_TYPE_EXPEDITED" ], "default": "PROPOSAL_TYPE_UNSPECIFIED", "description": "ProposalType enumerates the valid proposal types.\nAll proposal types are v1.Proposal which have different voting periods or tallying logic.\n\n - PROPOSAL_TYPE_UNSPECIFIED: PROPOSAL_TYPE_UNSPECIFIED defines no proposal type, which fallback to PROPOSAL_TYPE_STANDARD.\n - PROPOSAL_TYPE_STANDARD: PROPOSAL_TYPE_STANDARD defines the type for a standard proposal.\n - PROPOSAL_TYPE_MULTIPLE_CHOICE: PROPOSAL_TYPE_MULTIPLE_CHOICE defines the type for a multiple choice proposal.\n - PROPOSAL_TYPE_OPTIMISTIC: PROPOSAL_TYPE_OPTIMISTIC defines the type for an optimistic proposal.\n - PROPOSAL_TYPE_EXPEDITED: PROPOSAL_TYPE_EXPEDITED defines the type for an expedited proposal." } }, "description": "Proposal defines the core field members of a governance proposal." }, "description": "proposals defines all the requested governance proposals." }, "pagination": { "description": "pagination defines the pagination in the response.", "type": "object", "properties": { "next_key": { "type": "string", "format": "byte", "description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results." }, "total": { "type": "string", "format": "uint64", "title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise" } } } }, "description": "QueryProposalsResponse is the response type for the Query/Proposals RPC\nmethod." } } } }, "default": { "description": "An unexpected error response.", "content": { "*/*": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." } }, "additionalProperties": {}, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" } } } } } } } }, "parameters": [ { "name": "proposal_status", "description": "proposal_status defines the status of the proposals.\n\n - PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.\n - PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit\nperiod.\n - PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting\nperiod.\n - PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has\npassed.\n - PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has\nbeen rejected.\n - PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has\nfailed.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PROPOSAL_STATUS_UNSPECIFIED", "PROPOSAL_STATUS_DEPOSIT_PERIOD", "PROPOSAL_STATUS_VOTING_PERIOD", "PROPOSAL_STATUS_PASSED", "PROPOSAL_STATUS_REJECTED", "PROPOSAL_STATUS_FAILED" ], "default": "PROPOSAL_STATUS_UNSPECIFIED" } }, { "name": "voter", "description": "voter defines the voter address for the proposals.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "depositor", "description": "depositor defines the deposit addresses from the proposals.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pagination.key", "description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.", "in": "query", "required": false, "schema": { "type": "string", "format": "byte" } }, { "name": "pagination.offset", "description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.", "in": "query", "required": false, "schema": { "type": "string", "format": "uint64" } }, { "name": "pagination.limit", "description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.", "in": "query", "required": false, "schema": { "type": "string", "format": "uint64" } }, { "name": "pagination.count_total", "description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pagination.reverse", "description": "reverse is set to true if results are to be returned in the descending order.", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "tags": [ "Query" ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```