AI Agent
b2a29fe51f
- Added new documentation URLs from llms.txt index - Updated TARGET.md with 244 total documentation pages - Scraped new pages for trading, concepts, and API reference sections - Updated changelog and new index pages
148 lines
5.1 KiB
Markdown
148 lines
5.1 KiB
Markdown
> ## Documentation Index
|
|
> Fetch the complete documentation index at: https://docs.polymarket.com/llms.txt
|
|
> Use this file to discover all available pages before exploring further.
|
|
|
|
# API Keys
|
|
|
|
> Create and manage your Builder API credentials
|
|
|
|
Builder API keys authenticate your application with Polymarket's relayer and enable order attribution. You'll need these credentials to access gasless transactions and track volume.
|
|
|
|
## Accessing Your Builder Profile
|
|
|
|
<Steps>
|
|
<Step title="Direct Link">
|
|
Go to
|
|
[polymarket.com/settings?tab=builder](https://polymarket.com/settings?tab=builder)
|
|
</Step>
|
|
|
|
<Step title="From Menu">Click your profile image → Select "Builders"</Step>
|
|
</Steps>
|
|
|
|
## Creating API Keys
|
|
|
|
In the **Builder Keys** section of your profile:
|
|
|
|
1. Click **"+ Create New"** to generate a new API key
|
|
2. **Copy all three values immediately** — the secret and passphrase are only shown once
|
|
3. Store them securely in your secrets manager or environment variables
|
|
|
|
Each API key includes three components:
|
|
|
|
| Component | Description | Example |
|
|
| ------------ | ------------------------------------------ | ----------------------- |
|
|
| `key` | Public identifier for your builder account | `abc123-def456-...` |
|
|
| `secret` | Secret key for signing requests | `base64-encoded-secret` |
|
|
| `passphrase` | Additional authentication value | `your-passphrase` |
|
|
|
|
<Warning>
|
|
The `secret` and `passphrase` are only displayed once when created. If you
|
|
lose them, you'll need to generate a new key.
|
|
</Warning>
|
|
|
|
## Managing Keys
|
|
|
|
Create separate keys for different environments:
|
|
|
|
| Environment | Purpose |
|
|
| ----------- | ----------------------------- |
|
|
| Development | Testing and local development |
|
|
| Staging | Pre-production testing |
|
|
| Production | Live trading |
|
|
|
|
## Profile Settings
|
|
|
|
Your builder profile includes customizable settings:
|
|
|
|
| Setting | Description |
|
|
| ------------------- | ----------------------------------------------------------------------- |
|
|
| **Profile Picture** | Displayed on the [Builder Leaderboard](https://builders.polymarket.com) |
|
|
| **Builder Name** | Public name shown on the leaderboard |
|
|
| **Builder Address** | Your unique builder identifier (read-only) |
|
|
| **Current Tier** | Your rate limit tier: Unverified, Verified, or Partner |
|
|
|
|
## Environment Variables
|
|
|
|
Store your credentials as environment variables:
|
|
|
|
<Tabs>
|
|
<Tab title="Bash">
|
|
```bash .env theme={null}
|
|
POLY_BUILDER_API_KEY=your-api-key
|
|
POLY_BUILDER_SECRET=your-secret
|
|
POLY_BUILDER_PASSPHRASE=your-passphrase
|
|
```
|
|
</Tab>
|
|
|
|
<Tab title="TypeScript">
|
|
```typescript theme={null}
|
|
import { BuilderApiKeyCreds } from "@polymarket/builder-signing-sdk";
|
|
|
|
const builderCreds: BuilderApiKeyCreds = {
|
|
key: process.env.POLY_BUILDER_API_KEY!,
|
|
secret: process.env.POLY_BUILDER_SECRET!,
|
|
passphrase: process.env.POLY_BUILDER_PASSPHRASE!,
|
|
};
|
|
```
|
|
</Tab>
|
|
|
|
<Tab title="Python">
|
|
```python theme={null}
|
|
import os
|
|
from py_builder_signing_sdk import BuilderApiKeyCreds
|
|
|
|
builder_creds = BuilderApiKeyCreds(
|
|
key=os.environ["POLY_BUILDER_API_KEY"],
|
|
secret=os.environ["POLY_BUILDER_SECRET"],
|
|
passphrase=os.environ["POLY_BUILDER_PASSPHRASE"],
|
|
)
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Security Best Practices
|
|
|
|
| Practice | Description |
|
|
| ----------------------------- | --------------------------------------------------------- |
|
|
| **Never commit credentials** | Use `.gitignore` to exclude `.env` files |
|
|
| **Use environment variables** | Load credentials from env vars, not hardcoded strings |
|
|
| **Use a secrets manager** | AWS Secrets Manager, HashiCorp Vault, etc. for production |
|
|
| **Separate environments** | Use different keys for dev, staging, and production |
|
|
| **Monitor usage** | Check the leaderboard for unexpected volume changes |
|
|
|
|
<Warning>
|
|
**Never expose Builder API credentials in client-side code.** Your secret and
|
|
passphrase must stay on your server.
|
|
</Warning>
|
|
|
|
## Troubleshooting
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Rate limit exceeded">
|
|
**Cause:** You've exceeded your tier's daily transaction limit.
|
|
|
|
**Solution:**
|
|
|
|
* Wait until the daily limit resets
|
|
* [Contact Polymarket](/builders/tiers#contact) to upgrade your tier
|
|
</Accordion>
|
|
|
|
<Accordion title="Lost secret or passphrase">
|
|
**Cause:** The secret and passphrase are only shown once when created.
|
|
|
|
**Solution:** Create a new API key. You cannot recover the original values.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Attribute Orders" icon="tag" href="/trading/orders/attribution">
|
|
Configure your client to credit trades to your account.
|
|
</Card>
|
|
|
|
<Card title="Understand Tiers" icon="layer-group" href="/builders/tiers">
|
|
Learn about rate limits and how to upgrade.
|
|
</Card>
|
|
</CardGroup>
|