solana/docs/src/api/methods/_getMultipleAccounts.mdx

149 lines
3.7 KiB
Plaintext

import {
DocBlock,
DocSideBySide,
CodeParams,
Parameter,
Field,
Values,
CodeSnippets,
} from "../../../components/CodeDocBlock";
<DocBlock>
## getMultipleAccounts
Returns the account information for a list of Pubkeys.
<DocSideBySide>
<CodeParams>
### Parameters:
<Parameter type={"array"} required={true}>
An array of Pubkeys to query, as base-58 encoded strings (up to a maximum of
100)
</Parameter>
<Parameter type={"object"} optional={true}>
Configuration object containing the following fields:
<Field
name="commitment"
type="string"
optional={true}
href="/api/http#configuring-state-commitment"
></Field>
<Field name="minContextSlot" type="number" optional={true}>
The minimum slot that the request can be evaluated at
</Field>
<Field name="dataSlice" type="object" optional={true}>
Request a slice of the account&apos;s data.
- `length: <usize>` - number of bytes to return
- `offset: <usize>` - byte offset from which to start reading
:::info
Data slicing is only available for <code>base58</code>, <code>base64</code>, or <code>base64+zstd</code> encodings.
:::
</Field>
<Field name="encoding" type="string" optional={true} defaultValue={"base64"} href="/api/http#parsed-responses">
encoding format for the returned Account data
<Values values={["jsonParsed", "base58", "base64", "base64+zstd"]} />
<details>
- `base58` is slow and limited to less than 129 bytes of Account data.
- `base64` will return base64 encoded data for Account data of any size.
- `base64+zstd` compresses the Account data using [Zstandard](https://facebook.github.io/zstd/)
and base64-encodes the result.
- [`jsonParsed` encoding](/api/http#parsed-responses) attempts to use program-specific state parsers to
return more human-readable and explicit account state data.
- If `jsonParsed` is requested but a parser cannot be found, the field falls back to `base64`
encoding, detectable when the `data` field is type `<string>`.
</details>
</Field>
</Parameter>
### Result:
The result will be a JSON object with `value` equal to an array of:
- `<null>` - if the account at that Pubkey doesn't exist, or
- `<object>` - a JSON object containing:
- `lamports: <u64>` - number of lamports assigned to this account, as a u64
- `owner: <string>` - base-58 encoded Pubkey of the program this account has been assigned to
- `data: <[string, encoding]|object>` - data associated with the account, either as encoded binary data or JSON format `{<program>: <state>}` - depending on encoding parameter
- `executable: <bool>` - boolean indicating if the account contains a program \(and is strictly read-only\)
- `rentEpoch: <u64>` - the epoch at which this account will next owe rent, as u64
- `size: <u64>` - the data size of the account
</CodeParams>
<CodeSnippets>
### Code sample:
```bash
curl http://localhost:8899 -X POST -H "Content-Type: application/json" -d '
{
"jsonrpc": "2.0",
"id": 1,
"method": "getMultipleAccounts",
"params": [
[
"vines1vzrYbzLMRdu58ou5XTby4qAqVRLmqo36NKPTg",
"4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA"
],
{
"encoding": "base58"
}
]
}
'
```
### Response:
```json
{
"jsonrpc": "2.0",
"result": {
"context": {
"slot": 1
},
"value": [
{
"data": ["", "base64"],
"executable": false,
"lamports": 1000000000,
"owner": "11111111111111111111111111111111",
"rentEpoch": 2,
"space": 16
},
{
"data": ["", "base64"],
"executable": false,
"lamports": 5000000000,
"owner": "11111111111111111111111111111111",
"rentEpoch": 2,
"space": 0
}
]
},
"id": 1
}
```
</CodeSnippets>
</DocSideBySide>
</DocBlock>