POST /api/broker/connect

All endpoints · Authentication and retries · Download OpenAPI

• Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.
• Only paper-trading connections are supported. Omit environment or send paper. Use your own broker credentials in this protected request; never put credentials in a URL or shared example.
• Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.

Request

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

{
  "apiKeyId": "1",
  "apiSecret": "REPLACE_WITH_YOUR_FLOW_VALUE"
}

curl --include \
  --request POST \
  'https://api.weavers.app/api/broker/connect' \
  --cookie cookies.txt --cookie-jar cookies.txt \
  --header 'Origin: https://weavers.app' \
  --header "X-CSRF-Token: ${CSRF_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

{
  "connected": false,
  "providerId": "alpaca",
  "providerLabel": "Example research",
  "connectMode": "api_key",
  "environment": "paper",
  "accountId": null
}

{
  "error": "example"
}

{}

{}

{
  "error": "example"
}

{}

{
  "error": "example"
}

{
  "error": "example"
}

{
  "error": "example"
}