Skip to content

Commit

Permalink
add docs for the rounds
Browse files Browse the repository at this point in the history
  • Loading branch information
alfonsobries committed Jun 12, 2024
1 parent 6d68cff commit 518f6fa
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/sdk/php/client/api-documentation.md.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -491,6 +491,62 @@ public function schemas()

`array`

## ArkEcosystem\Client\API\Rounds

### `show()`

```php
public function show(int $round_id)
```

Get a round by the given id.

#### Parameters

| Type | Name | Required | Description |
| :--- | :--- | :--- | :--- |
| string | round_id | Yes | Round ID |

#### Return Value

`array`

### `all()`

```php
public function all(array $query = [])
```

Get all rounds.

#### Parameters

| Type | Name | Required | Description |
| :--- | :--- | :--- | :--- |
| array | query | No | Query parameters |

#### Return Value

`array`

### `delegates()`

```php
public function delegates(int $round_id)
```

Get the forging delegates of a round by the given id.

#### Parameters

| Type | Name | Required | Description |
| :--- | :--- | :--- | :--- |
| string | round_id | Yes | Round ID |

#### Return Value

`array`

## ArkEcosystem\Client\API\Votes

### `all()`
Expand Down

0 comments on commit 518f6fa

Please sign in to comment.