kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
25 lines (17 loc) • 1.05 kB
Markdown
# CreateApiKeyRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name for the API key. This helps identify the key\'s purpose | [default to undefined]
**public_key** | **string** | RSA public key in PEM format. This will be used to verify signatures on API requests | [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 { CreateApiKeyRequest } from 'kalshi-typescript';
const instance: CreateApiKeyRequest = {
name,
public_key,
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)