Skip to content

Create AUTHORIZATION.md #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CRF1408 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create AUTHORIZATION.md #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/AUTHORIZATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# API authorization and scopes

The Polymarket agents require valid API keys to interact with the backend.

## API keys

- Obtain an API key from your dashboard and keep it secret.
- Set `POLYMARKET_API_KEY` in your `.env` file or environment.

## Scopes

API keys may have different scopes:

- `read:markets` – read market data
- `trade:orders` – place and cancel orders
- `read:positions` – read your positions

When generating a key, select the minimum required scopes. Expose keys only to trusted systems.

## Revocation

You can revoke an API key at any time from your dashboard. The agent will stop functioning until you provide a new key.