HTTP API reference › GalaSwap DEX › protocol-fee-sweep
GalaSwap DEX — protocol-fee-sweep
2 operations in this group.
- POST /v1/protocol-fee-sweep/run — POST /v1/protocol-fee-sweep/run
- GET /v1/protocol-fee-sweep/reports — GET /v1/protocol-fee-sweep/reports
POST /v1/protocol-fee-sweep/run
ProtocolFeeSweepController_run
POST /v1/protocol-fee-sweep/run
POST /v1/protocol-fee-sweep/run
Authentication: api-key
Responses
200 —
Content type: application/json
Schema: SweepReportResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
| startedAt | string (date-time) | yes | |
| finishedAt | string (date-time) | yes | |
| dryRun | boolean | yes | |
| destination | string | yes | |
| poolsScanned | number | yes | |
| poolsCollected | number | yes | |
| poolsSkippedDust | number | yes | |
| poolsFailed | number | yes | |
| totalsByToken | object | yes | |
| pools | array<PoolSweepResultResponseDto> | yes |
401 —
Content type: application/json
Schema: ProtocolFeeSweepHttpErrorResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
| statusCode | number | yes | |
| message | oneOf: string | array<string> | yes | |
| error | string | no |
403 —
Content type: application/json
Schema: ProtocolFeeSweepHttpErrorResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
| statusCode | number | yes | |
| message | oneOf: string | array<string> | yes | |
| error | string | no |
409 —
Content type: application/json
Schema: ProtocolFeeSweepHttpErrorResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
| statusCode | number | yes | |
| message | oneOf: string | array<string> | yes | |
| error | string | no |
default — An error response using the shared backend error envelope.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| status | integer | yes | |
| error | boolean | yes | |
| message | string | yes | |
| errorKey | string | no |
Example response
[]
GET /v1/protocol-fee-sweep/reports
ProtocolFeeSweepController_reports
GET /v1/protocol-fee-sweep/reports
GET /v1/protocol-fee-sweep/reports
Authentication: api-key
Responses
200 —
Content type: application/json
Schema: array<SweepReportResponseDto>
| Field | Type | Required | Description |
|---|---|---|---|
| items.startedAt | string (date-time) | yes | |
| items.finishedAt | string (date-time) | yes | |
| items.dryRun | boolean | yes | |
| items.destination | string | yes | |
| items.poolsScanned | number | yes | |
| items.poolsCollected | number | yes | |
| items.poolsSkippedDust | number | yes | |
| items.poolsFailed | number | yes | |
| items.totalsByToken | object | yes | |
| items.pools | array<PoolSweepResultResponseDto> | yes |
401 —
Content type: application/json
Schema: ProtocolFeeSweepHttpErrorResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
| statusCode | number | yes | |
| message | oneOf: string | array<string> | yes | |
| error | string | no |
403 —
Content type: application/json
Schema: ProtocolFeeSweepHttpErrorResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
| statusCode | number | yes | |
| message | oneOf: string | array<string> | yes | |
| error | string | no |
default — An error response using the shared backend error envelope.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| status | integer | yes | |
| error | boolean | yes | |
| message | string | yes | |
| errorKey | string | no |
Example response
[]
Previous group: ExtensionVersion · Next group: WhatsNew