UNPKG

kalshi-typescript

Version:
23 lines (15 loc) 898 B
# GenerateApiKeyRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name for the API key. This helps identify the key\'s purpose | [default to undefined] **scopes** | **Array<string>** | List of scopes to grant to the API key. Valid values are \'read\' and \'write\'. If \'write\' is included, \'read\' must also be included. Defaults to full access ([\'read\', \'write\']) if not provided. | [optional] [default to undefined] ## Example ```typescript import { GenerateApiKeyRequest } from 'kalshi-typescript'; const instance: GenerateApiKeyRequest = { name, scopes, }; ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)