Skip to content

Commit 64eaaa6

Browse files
committed
Switch to sentence case
1 parent edbfb50 commit 64eaaa6

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

‎docs/sdk-and-tools/rest-api/iterate-keys.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@ This endpoint will only work if the node's `config.toml` file has the following
2222

2323
[comment]: # (mx-context-auto)
2424

25-
## Endpoint Details
25+
## Endpoint details
2626

2727
- **Method:** POST
2828
- **Path:** `/address/iterate-keys`
2929
- **Optional:** `/address/iterate-keys?blockNonce={blockNonce}`
3030

31-
### Request Body
31+
### Request body
3232

3333
| Field | Type | Description |
3434
| -------------- | ------ | --------------------------------------------------------------------------------------------------|
3535
| `address` | string | Address of the account whose storage keys you want to iterate. |
3636
| `numKeys` | int | Number of keys to retrieve in this batch. If 0, retrieves as many as possible until timeout. |
3737
| `iteratorState`| array | Set to empty array for the first request, or use the value from the previous response to resume. |
3838

39-
#### Example First Request
39+
#### Example - First request
4040

4141
```json
4242
{
@@ -46,7 +46,7 @@ This endpoint will only work if the node's `config.toml` file has the following
4646
}
4747
```
4848

49-
#### Example Subsequent Request
49+
#### Example - Subsequent request
5050

5151
```json
5252
{
@@ -69,7 +69,7 @@ This endpoint will only work if the node's `config.toml` file has the following
6969
```
7070

7171

72-
### Response Body
72+
### Response body
7373

7474
| Field | Type | Description |
7575
|-------------------------|---------------------|-----------------------------------------------------------------------------|
@@ -79,7 +79,7 @@ This endpoint will only work if the node's `config.toml` file has the following
7979
| `error` | string | Error message, if any. |
8080
| `code` | string | Status code, e.g., "successful". |
8181

82-
#### Example Response (more data to fetch)
82+
#### Example response (more data to fetch)
8383

8484
```json
8585
{
@@ -117,7 +117,7 @@ This endpoint will only work if the node's `config.toml` file has the following
117117
}
118118
```
119119

120-
#### Example Response (iteration complete)
120+
#### Example response (iteration complete)
121121

122122
```json
123123
{
@@ -139,7 +139,7 @@ This endpoint will only work if the node's `config.toml` file has the following
139139

140140
[comment]: # (mx-context-auto)
141141

142-
## Usage Notes
142+
## Usage notes
143143

144144
- The `pairs` object contains hex-encoded keys and values. Decode as needed.
145145
- Always pass `newIteratorState` as-is in your next request's `iteratorState` field to continue iteration.
@@ -151,11 +151,11 @@ This endpoint will only work if the node's `config.toml` file has the following
151151

152152
[comment]: # (mx-context-auto)
153153

154-
## Example Usage
154+
## Example usage
155155

156-
1. **Initial Request:**
156+
1. **Initial request:**
157157
- Send a POST with `iteratorState` as an empty array and desired `numKeys` (or 0 for maximum batch).
158-
2. **Subsequent Requests:**
158+
2. **Subsequent requests:**
159159
- Use the `newIteratorState` from the previous response to fetch the next batch. Pass it as-is.
160160
- Optionally, provide `blockNonce` to ensure consistency if the account may change.
161161
3. **Finish:**

0 commit comments

Comments
 (0)