# Endpoints

## GET /ton-rewards/spec.json

> Api Spec

```json
{"openapi":"3.1.0","info":{"title":"Chorus One TON Pool Rewards API","version":"1.16.0"},"paths":{"/ton-rewards/spec.json":{"get":{"tags":["Endpoints"],"summary":"Api Spec","operationId":"api_spec_ton_rewards_spec_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Api Spec Ton Rewards Spec Json Get"}}}}}}}}}
```

## GET /ton-rewards/docs

> Docs

```json
{"openapi":"3.1.0","info":{"title":"Chorus One TON Pool Rewards API","version":"1.16.0"},"paths":{"/ton-rewards/docs":{"get":{"tags":["Endpoints"],"summary":"Docs","operationId":"docs_ton_rewards_docs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Docs Ton Rewards Docs Get"}}}}}}}}}
```

## GET /ton-rewards/v1/nominator\_rewards

> Get Nominator Rewards

```json
{"openapi":"3.1.0","info":{"title":"Chorus One TON Pool Rewards API","version":"1.16.0"},"security":[{"APIKeyHeader":[]}],"components":{"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"TonV1NominatorRewards":{"properties":{"nominator_address":{"type":"string","title":"Nominator Address","description":"User friendly nominator address"},"entries":{"items":{"$ref":"#/components/schemas/TonV1NominatorRewardsEntry"},"type":"array","title":"Entries","description":"All staking entries for this nominator across pools and time"}},"type":"object","required":["nominator_address","entries"],"title":"TonV1NominatorRewards"},"TonV1NominatorRewardsEntry":{"properties":{"pool_address":{"type":"string","title":"Pool Address","description":"Pool address"},"seqno":{"type":"integer","title":"Seqno","description":"Snapshot sequence number"},"timestamp":{"type":"integer","title":"Timestamp","description":"Snapshot timestamp"},"snapshot_time":{"type":"string","format":"date-time","title":"Snapshot Time","description":"Snapshot datetime"},"denom":{"type":"string","title":"Denom","description":"Denominator (nton for Ton)"},"stake_amount":{"type":"string","title":"Stake Amount","description":"Staked amount"},"rewards":{"type":"string","title":"Rewards","description":"Rewards amount"},"arr":{"type":"string","title":"Arr","description":"ARR"},"new_stake":{"type":"string","title":"New Stake","description":"New stake"},"withdrawal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Withdrawal","description":"Withdrawal amount"}},"type":"object","required":["pool_address","seqno","timestamp","snapshot_time","denom","stake_amount","rewards","arr","new_stake","withdrawal"],"title":"TonV1NominatorRewardsEntry"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/ton-rewards/v1/nominator_rewards":{"get":{"tags":["Endpoints"],"summary":"Get Nominator Rewards","operationId":"Get_nominator_rewards_ton_rewards_v1_nominator_rewards_get","parameters":[{"name":"since_inclusive","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Timestamp (ISO-8601 with time zone). From the beginning if not set","title":"Since Inclusive"},"description":"Timestamp (ISO-8601 with time zone). From the beginning if not set"},{"name":"to_exclusive","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Timestamp (ISO-8601 with time zone). Up to most recent entry if not set","title":"To Exclusive"},"description":"Timestamp (ISO-8601 with time zone). Up to most recent entry if not set"},{"name":"nominator_address","in":"query","required":true,"schema":{"type":"string","description":"User friendly nominator address, EQ...","title":"Nominator Address"},"description":"User friendly nominator address, EQ..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TonV1NominatorRewards"}}}},"401":{"description":"Unrecognized or missing API key"},"404":{"description":"Data not found for the filter"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /ton-rewards/v1/pool\_rewards

> Get Pool Rewards

```json
{"openapi":"3.1.0","info":{"title":"Chorus One TON Pool Rewards API","version":"1.16.0"},"security":[{"APIKeyHeader":[]}],"components":{"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"TonV1PoolRewards":{"properties":{"pool_address":{"type":"string","title":"Pool Address","description":"Pool address"},"entries":{"items":{"$ref":"#/components/schemas/TonV1PoolRewardsEntry"},"type":"array","title":"Entries","description":"All commission entries for this pool across time"}},"type":"object","required":["pool_address","entries"],"title":"TonV1PoolRewards"},"TonV1PoolRewardsEntry":{"properties":{"seqno":{"type":"integer","title":"Seqno","description":"Snapshot sequence number"},"timestamp":{"type":"integer","title":"Timestamp","description":"Snapshot timestamp"},"snapshot_time":{"type":"string","format":"date-time","title":"Snapshot Time","description":"Snapshot datetime"},"denom":{"type":"string","title":"Denom","description":"Denominator (nton for Ton)"},"stake_amount":{"type":"string","title":"Stake Amount","description":"Staked amount"},"rewards":{"type":"string","title":"Rewards","description":"Rewards amount"},"commissions":{"type":"string","title":"Commissions","description":"Pool commissions"},"c1_commissions":{"type":"string","title":"C1 Commissions","description":"Chorus One commissions"},"neto_nominator_arr":{"type":"string","title":"Neto Nominator Arr","description":"Neto nominator ARR"},"pool_arr":{"type":"string","title":"Pool Arr","description":"Pool ARR"},"nominators_count":{"type":"integer","title":"Nominators Count","description":"Number of nominators in pool at time"}},"type":"object","required":["seqno","timestamp","snapshot_time","denom","stake_amount","rewards","commissions","c1_commissions","neto_nominator_arr","pool_arr","nominators_count"],"title":"TonV1PoolRewardsEntry"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/ton-rewards/v1/pool_rewards":{"get":{"tags":["Endpoints"],"summary":"Get Pool Rewards","operationId":"Get_pool_rewards_ton_rewards_v1_pool_rewards_get","parameters":[{"name":"since_inclusive","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Timestamp (ISO-8601 with time zone). From the beginning if not set","title":"Since Inclusive"},"description":"Timestamp (ISO-8601 with time zone). From the beginning if not set"},{"name":"to_exclusive","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Timestamp (ISO-8601 with time zone). Up to most recent entry if not set","title":"To Exclusive"},"description":"Timestamp (ISO-8601 with time zone). Up to most recent entry if not set"},{"name":"pool_address","in":"query","required":true,"schema":{"type":"string","description":"Pool address","title":"Pool Address"},"description":"Pool address"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TonV1PoolRewards"}}}},"401":{"description":"Unrecognized or missing API key"},"404":{"description":"Data not found for the filter"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```