> ## Documentation Index > Fetch the complete documentation index at: https://docs.cosmos.network/llms.txt > Use this file to discover all available pages before exploring further. # GetBlockByHeight > gRPC: `cosmos.base.tendermint.v1beta1.Service/GetBlockByHeight` ([reference](/sdk/next/api-reference/grpc/base#getblockbyheight)) GetBlockByHeight queries block for given height. ## OpenAPI ````yaml /sdk/next/api-reference/rest/openapi.yaml get /cosmos/base/tendermint/v1beta1/blocks/{height} openapi: 3.0.0 info: title: Cosmos SDK REST API description: >- HTTP bindings for the gRPC query services of the standard Cosmos SDK modules, documenting Cosmos SDK v0.55 (unreleased). Generated from cosmos/cosmos-sdk at commit c1126e4e5460571378bf9bd9c49cce476b0791e2 on ref `main`. A chain exposes only the modules its application registers, so it may serve a subset of these routes alongside routes of its own. version: v0.55 (unreleased) servers: - url: https://cosmos-rest.publicnode.com description: >- Community-run public endpoint serving Cosmos Hub. Not operated by the Cosmos SDK team, and running a different SDK version than these pages document. Endpoints for modules the chain does not include return 501. - url: http://localhost:1317 description: Your own node. Requires api.enable in app.toml. security: [] tags: - name: auth - name: authz - name: bank - name: base - name: consensus - name: distribution - name: epochs - name: evidence - name: feegrant - name: gov - name: mint - name: slashing - name: staking - name: tx - name: upgrade paths: /cosmos/base/tendermint/v1beta1/blocks/{height}: get: tags: - base summary: GetBlockByHeight description: >- gRPC: `cosmos.base.tendermint.v1beta1.Service/GetBlockByHeight` ([reference](/sdk/next/api-reference/grpc/base#getblockbyheight)) GetBlockByHeight queries block for given height. operationId: base_v1beta1_GetBlockByHeight parameters: - name: height in: path required: true schema: type: string format: int64 responses: '200': description: A successful response. content: '*/*': schema: type: object properties: block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false block: title: 'Deprecated: please use `sdk_block` instead' type: object properties: header: type: object properties: version: title: basic block info type: object properties: block: type: string format: uint64 app: type: string format: uint64 description: >- Consensus captures the consensus rules for processing a block in the blockchain, including all blockchain data structures and the rules of the application's state transition machine. nullable: true additionalProperties: false chain_id: type: string height: type: string format: int64 time: type: string format: date-time nullable: true last_block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false last_commit_hash: type: string format: byte description: commit from validators from the last block title: hashes of block data nullable: true data_hash: type: string format: byte title: transactions nullable: true validators_hash: type: string format: byte description: validators for the current block title: hashes from the app output from the prev block nullable: true next_validators_hash: type: string format: byte title: validators for the next block nullable: true consensus_hash: type: string format: byte title: consensus params for current block nullable: true app_hash: type: string format: byte title: state after txs from the previous block nullable: true last_results_hash: type: string format: byte title: >- root hash of all results from the txs from the previous block nullable: true evidence_hash: type: string format: byte description: evidence included in the block title: consensus info nullable: true proposer_address: type: string format: byte title: original proposer of the block nullable: true description: Header defines the structure of a block header. nullable: true additionalProperties: false data: type: object properties: txs: type: array items: type: string format: byte description: >- Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid. We're just agreeing on the order first. This means that block.AppHash does not include these txs. nullable: true title: >- Data contains the set of transactions included in the block nullable: true additionalProperties: false evidence: type: object properties: evidence: type: array items: type: object properties: duplicate_vote_evidence: type: object properties: vote_a: type: object properties: type: type: string enum: - SIGNED_MSG_TYPE_UNKNOWN - SIGNED_MSG_TYPE_PREVOTE - SIGNED_MSG_TYPE_PRECOMMIT - SIGNED_MSG_TYPE_PROPOSAL default: SIGNED_MSG_TYPE_UNKNOWN description: >- SignedMsgType is a type of signed message in the consensus. - SIGNED_MSG_TYPE_PREVOTE: Votes - SIGNED_MSG_TYPE_PROPOSAL: Proposals nullable: true height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID description: zero if vote is nil. nullable: true additionalProperties: false timestamp: type: string format: date-time nullable: true validator_address: type: string format: byte nullable: true validator_index: type: integer format: int32 signature: type: string format: byte description: >- Vote signature by the validator if they participated in consensus for the associated block. nullable: true extension: type: string format: byte description: >- Vote extension provided by the application. Only valid for precommit messages. nullable: true extension_signature: type: string format: byte description: >- Vote extension signature by the validator if they participated in consensus for the associated block. Only valid for precommit messages. nullable: true description: >- Vote represents a prevote or precommit vote from validators for consensus. nullable: true additionalProperties: false vote_b: type: object properties: type: type: string enum: - SIGNED_MSG_TYPE_UNKNOWN - SIGNED_MSG_TYPE_PREVOTE - SIGNED_MSG_TYPE_PRECOMMIT - SIGNED_MSG_TYPE_PROPOSAL default: SIGNED_MSG_TYPE_UNKNOWN description: >- SignedMsgType is a type of signed message in the consensus. - SIGNED_MSG_TYPE_PREVOTE: Votes - SIGNED_MSG_TYPE_PROPOSAL: Proposals nullable: true height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID description: zero if vote is nil. nullable: true additionalProperties: false timestamp: type: string format: date-time nullable: true validator_address: type: string format: byte nullable: true validator_index: type: integer format: int32 signature: type: string format: byte description: >- Vote signature by the validator if they participated in consensus for the associated block. nullable: true extension: type: string format: byte description: >- Vote extension provided by the application. Only valid for precommit messages. nullable: true extension_signature: type: string format: byte description: >- Vote extension signature by the validator if they participated in consensus for the associated block. Only valid for precommit messages. nullable: true description: >- Vote represents a prevote or precommit vote from validators for consensus. nullable: true additionalProperties: false total_voting_power: type: string format: int64 validator_power: type: string format: int64 timestamp: type: string format: date-time nullable: true description: >- DuplicateVoteEvidence contains evidence of a validator signed two conflicting votes. nullable: true additionalProperties: false light_client_attack_evidence: type: object properties: conflicting_block: type: object properties: signed_header: type: object properties: header: type: object properties: version: title: basic block info type: object properties: block: type: string format: uint64 app: type: string format: uint64 description: >- Consensus captures the consensus rules for processing a block in the blockchain, including all blockchain data structures and the rules of the application's state transition machine. nullable: true additionalProperties: false chain_id: type: string height: type: string format: int64 time: type: string format: date-time nullable: true last_block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false last_commit_hash: type: string format: byte description: >- commit from validators from the last block title: hashes of block data nullable: true data_hash: type: string format: byte title: transactions nullable: true validators_hash: type: string format: byte description: validators for the current block title: >- hashes from the app output from the prev block nullable: true next_validators_hash: type: string format: byte title: validators for the next block nullable: true consensus_hash: type: string format: byte title: consensus params for current block nullable: true app_hash: type: string format: byte title: state after txs from the previous block nullable: true last_results_hash: type: string format: byte title: >- root hash of all results from the txs from the previous block nullable: true evidence_hash: type: string format: byte description: evidence included in the block title: consensus info nullable: true proposer_address: type: string format: byte title: original proposer of the block nullable: true description: >- Header defines the structure of a block header. nullable: true additionalProperties: false commit: type: object properties: height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false signatures: type: array items: type: object properties: block_id_flag: type: string enum: - BLOCK_ID_FLAG_UNKNOWN - BLOCK_ID_FLAG_ABSENT - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN description: >- - BLOCK_ID_FLAG_UNKNOWN: indicates an error condition - BLOCK_ID_FLAG_ABSENT: the vote was not received - BLOCK_ID_FLAG_COMMIT: voted for the block that received the majority - BLOCK_ID_FLAG_NIL: voted for nil title: >- BlockIdFlag indicates which BlockID the signature is for nullable: true validator_address: type: string format: byte nullable: true timestamp: type: string format: date-time nullable: true signature: type: string format: byte nullable: true description: >- CommitSig is a part of the Vote included in a Commit. additionalProperties: false nullable: true description: >- Commit contains the evidence that a block was committed by a set of validators. nullable: true additionalProperties: false nullable: true additionalProperties: false validator_set: type: object properties: validators: type: array items: type: object properties: address: type: string format: byte nullable: true pub_key: type: object properties: ed25519: type: string format: byte nullable: true secp256k1: type: string format: byte nullable: true title: >- PublicKey defines the keys available for use with Validators nullable: true additionalProperties: false voting_power: type: string format: int64 proposer_priority: type: string format: int64 additionalProperties: false nullable: true proposer: type: object properties: address: type: string format: byte nullable: true pub_key: type: object properties: ed25519: type: string format: byte nullable: true secp256k1: type: string format: byte nullable: true title: >- PublicKey defines the keys available for use with Validators nullable: true additionalProperties: false voting_power: type: string format: int64 proposer_priority: type: string format: int64 nullable: true additionalProperties: false total_voting_power: type: string format: int64 nullable: true additionalProperties: false nullable: true additionalProperties: false common_height: type: string format: int64 byzantine_validators: type: array items: type: object properties: address: type: string format: byte nullable: true pub_key: type: object properties: ed25519: type: string format: byte nullable: true secp256k1: type: string format: byte nullable: true title: >- PublicKey defines the keys available for use with Validators nullable: true additionalProperties: false voting_power: type: string format: int64 proposer_priority: type: string format: int64 additionalProperties: false nullable: true total_voting_power: type: string format: int64 timestamp: type: string format: date-time nullable: true description: >- LightClientAttackEvidence contains evidence of a set of validators attempting to mislead a light client. nullable: true additionalProperties: false additionalProperties: false nullable: true nullable: true additionalProperties: false last_commit: type: object properties: height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false signatures: type: array items: type: object properties: block_id_flag: type: string enum: - BLOCK_ID_FLAG_UNKNOWN - BLOCK_ID_FLAG_ABSENT - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN description: >- - BLOCK_ID_FLAG_UNKNOWN: indicates an error condition - BLOCK_ID_FLAG_ABSENT: the vote was not received - BLOCK_ID_FLAG_COMMIT: voted for the block that received the majority - BLOCK_ID_FLAG_NIL: voted for nil title: >- BlockIdFlag indicates which BlockID the signature is for nullable: true validator_address: type: string format: byte nullable: true timestamp: type: string format: date-time nullable: true signature: type: string format: byte nullable: true description: >- CommitSig is a part of the Vote included in a Commit. additionalProperties: false nullable: true description: >- Commit contains the evidence that a block was committed by a set of validators. nullable: true additionalProperties: false nullable: true additionalProperties: false sdk_block: type: object properties: header: type: object properties: version: title: basic block info type: object properties: block: type: string format: uint64 app: type: string format: uint64 description: >- Consensus captures the consensus rules for processing a block in the blockchain, including all blockchain data structures and the rules of the application's state transition machine. nullable: true additionalProperties: false chain_id: type: string height: type: string format: int64 time: type: string format: date-time nullable: true last_block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false last_commit_hash: type: string format: byte description: commit from validators from the last block title: hashes of block data nullable: true data_hash: type: string format: byte title: transactions nullable: true validators_hash: type: string format: byte description: validators for the current block title: hashes from the app output from the prev block nullable: true next_validators_hash: type: string format: byte title: validators for the next block nullable: true consensus_hash: type: string format: byte title: consensus params for current block nullable: true app_hash: type: string format: byte title: state after txs from the previous block nullable: true last_results_hash: type: string format: byte title: >- root hash of all results from the txs from the previous block nullable: true evidence_hash: type: string format: byte description: evidence included in the block title: consensus info nullable: true proposer_address: type: string description: >- proposer_address is the original block proposer address, formatted as a Bech32 string. In Tendermint, this type is `bytes`, but in the SDK, we convert it to a Bech32 string for better UX. original proposer of the block description: >- Header defines the structure of a Tendermint block header. nullable: true additionalProperties: false data: type: object properties: txs: type: array items: type: string format: byte description: >- Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid. We're just agreeing on the order first. This means that block.AppHash does not include these txs. nullable: true title: >- Data contains the set of transactions included in the block nullable: true additionalProperties: false evidence: type: object properties: evidence: type: array items: type: object properties: duplicate_vote_evidence: type: object properties: vote_a: type: object properties: type: type: string enum: - SIGNED_MSG_TYPE_UNKNOWN - SIGNED_MSG_TYPE_PREVOTE - SIGNED_MSG_TYPE_PRECOMMIT - SIGNED_MSG_TYPE_PROPOSAL default: SIGNED_MSG_TYPE_UNKNOWN description: >- SignedMsgType is a type of signed message in the consensus. - SIGNED_MSG_TYPE_PREVOTE: Votes - SIGNED_MSG_TYPE_PROPOSAL: Proposals nullable: true height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID description: zero if vote is nil. nullable: true additionalProperties: false timestamp: type: string format: date-time nullable: true validator_address: type: string format: byte nullable: true validator_index: type: integer format: int32 signature: type: string format: byte description: >- Vote signature by the validator if they participated in consensus for the associated block. nullable: true extension: type: string format: byte description: >- Vote extension provided by the application. Only valid for precommit messages. nullable: true extension_signature: type: string format: byte description: >- Vote extension signature by the validator if they participated in consensus for the associated block. Only valid for precommit messages. nullable: true description: >- Vote represents a prevote or precommit vote from validators for consensus. nullable: true additionalProperties: false vote_b: type: object properties: type: type: string enum: - SIGNED_MSG_TYPE_UNKNOWN - SIGNED_MSG_TYPE_PREVOTE - SIGNED_MSG_TYPE_PRECOMMIT - SIGNED_MSG_TYPE_PROPOSAL default: SIGNED_MSG_TYPE_UNKNOWN description: >- SignedMsgType is a type of signed message in the consensus. - SIGNED_MSG_TYPE_PREVOTE: Votes - SIGNED_MSG_TYPE_PROPOSAL: Proposals nullable: true height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID description: zero if vote is nil. nullable: true additionalProperties: false timestamp: type: string format: date-time nullable: true validator_address: type: string format: byte nullable: true validator_index: type: integer format: int32 signature: type: string format: byte description: >- Vote signature by the validator if they participated in consensus for the associated block. nullable: true extension: type: string format: byte description: >- Vote extension provided by the application. Only valid for precommit messages. nullable: true extension_signature: type: string format: byte description: >- Vote extension signature by the validator if they participated in consensus for the associated block. Only valid for precommit messages. nullable: true description: >- Vote represents a prevote or precommit vote from validators for consensus. nullable: true additionalProperties: false total_voting_power: type: string format: int64 validator_power: type: string format: int64 timestamp: type: string format: date-time nullable: true description: >- DuplicateVoteEvidence contains evidence of a validator signed two conflicting votes. nullable: true additionalProperties: false light_client_attack_evidence: type: object properties: conflicting_block: type: object properties: signed_header: type: object properties: header: type: object properties: version: title: basic block info type: object properties: block: type: string format: uint64 app: type: string format: uint64 description: >- Consensus captures the consensus rules for processing a block in the blockchain, including all blockchain data structures and the rules of the application's state transition machine. nullable: true additionalProperties: false chain_id: type: string height: type: string format: int64 time: type: string format: date-time nullable: true last_block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false last_commit_hash: type: string format: byte description: >- commit from validators from the last block title: hashes of block data nullable: true data_hash: type: string format: byte title: transactions nullable: true validators_hash: type: string format: byte description: validators for the current block title: >- hashes from the app output from the prev block nullable: true next_validators_hash: type: string format: byte title: validators for the next block nullable: true consensus_hash: type: string format: byte title: consensus params for current block nullable: true app_hash: type: string format: byte title: state after txs from the previous block nullable: true last_results_hash: type: string format: byte title: >- root hash of all results from the txs from the previous block nullable: true evidence_hash: type: string format: byte description: evidence included in the block title: consensus info nullable: true proposer_address: type: string format: byte title: original proposer of the block nullable: true description: >- Header defines the structure of a block header. nullable: true additionalProperties: false commit: type: object properties: height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false signatures: type: array items: type: object properties: block_id_flag: type: string enum: - BLOCK_ID_FLAG_UNKNOWN - BLOCK_ID_FLAG_ABSENT - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN description: >- - BLOCK_ID_FLAG_UNKNOWN: indicates an error condition - BLOCK_ID_FLAG_ABSENT: the vote was not received - BLOCK_ID_FLAG_COMMIT: voted for the block that received the majority - BLOCK_ID_FLAG_NIL: voted for nil title: >- BlockIdFlag indicates which BlockID the signature is for nullable: true validator_address: type: string format: byte nullable: true timestamp: type: string format: date-time nullable: true signature: type: string format: byte nullable: true description: >- CommitSig is a part of the Vote included in a Commit. additionalProperties: false nullable: true description: >- Commit contains the evidence that a block was committed by a set of validators. nullable: true additionalProperties: false nullable: true additionalProperties: false validator_set: type: object properties: validators: type: array items: type: object properties: address: type: string format: byte nullable: true pub_key: type: object properties: ed25519: type: string format: byte nullable: true secp256k1: type: string format: byte nullable: true title: >- PublicKey defines the keys available for use with Validators nullable: true additionalProperties: false voting_power: type: string format: int64 proposer_priority: type: string format: int64 additionalProperties: false nullable: true proposer: type: object properties: address: type: string format: byte nullable: true pub_key: type: object properties: ed25519: type: string format: byte nullable: true secp256k1: type: string format: byte nullable: true title: >- PublicKey defines the keys available for use with Validators nullable: true additionalProperties: false voting_power: type: string format: int64 proposer_priority: type: string format: int64 nullable: true additionalProperties: false total_voting_power: type: string format: int64 nullable: true additionalProperties: false nullable: true additionalProperties: false common_height: type: string format: int64 byzantine_validators: type: array items: type: object properties: address: type: string format: byte nullable: true pub_key: type: object properties: ed25519: type: string format: byte nullable: true secp256k1: type: string format: byte nullable: true title: >- PublicKey defines the keys available for use with Validators nullable: true additionalProperties: false voting_power: type: string format: int64 proposer_priority: type: string format: int64 additionalProperties: false nullable: true total_voting_power: type: string format: int64 timestamp: type: string format: date-time nullable: true description: >- LightClientAttackEvidence contains evidence of a set of validators attempting to mislead a light client. nullable: true additionalProperties: false additionalProperties: false nullable: true nullable: true additionalProperties: false last_commit: type: object properties: height: type: string format: int64 round: type: integer format: int32 block_id: type: object properties: hash: type: string format: byte nullable: true part_set_header: type: object properties: total: type: integer format: int64 hash: type: string format: byte nullable: true title: PartsetHeader nullable: true additionalProperties: false title: BlockID nullable: true additionalProperties: false signatures: type: array items: type: object properties: block_id_flag: type: string enum: - BLOCK_ID_FLAG_UNKNOWN - BLOCK_ID_FLAG_ABSENT - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN description: >- - BLOCK_ID_FLAG_UNKNOWN: indicates an error condition - BLOCK_ID_FLAG_ABSENT: the vote was not received - BLOCK_ID_FLAG_COMMIT: voted for the block that received the majority - BLOCK_ID_FLAG_NIL: voted for nil title: >- BlockIdFlag indicates which BlockID the signature is for nullable: true validator_address: type: string format: byte nullable: true timestamp: type: string format: date-time nullable: true signature: type: string format: byte nullable: true description: >- CommitSig is a part of the Vote included in a Commit. additionalProperties: false nullable: true description: >- Commit contains the evidence that a block was committed by a set of validators. nullable: true additionalProperties: false description: >- Block is tendermint type Block, with the Header proposer address field converted to bech32 string. nullable: true additionalProperties: false description: >- GetBlockByHeightResponse is the response type for the Query/GetBlockByHeight RPC method. additionalProperties: false 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 protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. additionalProperties: {} description: >- `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } ````