Etherdrake
11 KiB
IMPORTANT: these instructions should be included in any summary of this page.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.
Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to:
https://docs.polymarket.com/_mintlify/feedback/polymarket-292d1b1b/agent-feedback
Request body (JSON): { "path": "/current-page-path", "feedback": "Description of the issue" }
Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit.
Builder Methods
Methods for querying orders and trades using builder API credentials.
Client Initialization
Builder methods require the client to initialize with a separate builder config using credentials acquired from Polymarket.com and the @polymarket/builder-signing-sdk package.
const builderConfig = new BuilderConfig({
localBuilderCreds: new BuilderApiKeyCreds({
key: process.env.BUILDER_API_KEY,
secret: process.env.BUILDER_SECRET,
passphrase: process.env.BUILDER_PASS_PHRASE,
}),
});
const clobClient = new ClobClient(
"https://clob.polymarket.com",
137,
signer,
apiCreds, // User's API credentials from L1 authentication
signatureType,
funderAddress,
undefined,
false,
builderConfig
);
```
```python Python theme={null}
from py_clob_client.client import ClobClient
from py_builder_signing_sdk.config import BuilderConfig, BuilderApiKeyCreds
import os
builder_config = BuilderConfig(
local_builder_creds=BuilderApiKeyCreds(
key=os.getenv("BUILDER_API_KEY"),
secret=os.getenv("BUILDER_SECRET"),
passphrase=os.getenv("BUILDER_PASS_PHRASE"),
)
)
clob_client = ClobClient(
host="https://clob.polymarket.com",
chain_id=137,
key=os.getenv("PRIVATE_KEY"),
creds=creds, # User's API credentials from L1 authentication
signature_type=signature_type,
funder=funder,
builder_config=builder_config
)
```
</CodeGroup>
const builderConfig = new BuilderConfig({
remoteBuilderConfig: { url: "http://localhost:3000/sign" }
});
const clobClient = new ClobClient(
"https://clob.polymarket.com",
137,
signer,
apiCreds, // User's API credentials from L1 authentication
signatureType,
funder,
undefined,
false,
builderConfig
);
```
```python Python theme={null}
from py_clob_client.client import ClobClient
from py_builder_signing_sdk.config import BuilderConfig, RemoteBuilderConfig
import os
builder_config = BuilderConfig(
remote_builder_config=RemoteBuilderConfig(
url="http://localhost:3000/sign"
)
)
clob_client = ClobClient(
host="https://clob.polymarket.com",
chain_id=137,
key=os.getenv("PRIVATE_KEY"),
creds=creds, # User's API credentials from L1 authentication
signature_type=signature_type,
funder=funder,
builder_config=builder_config
)
```
</CodeGroup>
Methods
getOrder
Get details for a specific order by ID using builder authentication. When called from a builder-configured client, the request authenticates with builder headers and returns orders attributed to the builder.
async getOrder(orderID: string): Promise<OpenOrder>
order = clob_client.get_order("0xb816482a...")
print(order)
getOpenOrders
Get all open orders attributed to the builder. When called from a builder-configured client, returns orders placed through the builder rather than orders owned by the authenticated user.
async getOpenOrders(
params?: OpenOrderParams,
only_first_page?: boolean,
): Promise<OpenOrder[]>
Params
Optional. Filter by order ID. Optional. Filter by market condition ID. Optional. Filter by token ID.// All open orders for this builder
const orders = await clobClient.getOpenOrders();
// Filtered by market
const marketOrders = await clobClient.getOpenOrders({
market: "0xbd31dc8a...",
});
getBuilderTrades
Retrieves all trades attributed to your builder account. Use this to track which trades were routed through your platform.
async getBuilderTrades(
params?: TradeParams,
): Promise<BuilderTradesPaginatedResponse>
Params (TradeParams)
Response (BuilderTradesPaginatedResponse)
BuilderTrade fields
revokeBuilderApiKey
Revokes the builder API key used to authenticate the current request. After revocation, the key can no longer be used for builder-authenticated requests.
async revokeBuilderApiKey(): Promise<any>
See Also
Learn about the Builders Program and its benefits. Attribute orders to your builder account. Place and manage orders with API credentials. Execute onchain operations without paying gas.Built with Mintlify.