API Reference / API keys
Create a workspace API key
Creates an API key scoped to a workspace with the given policies and optional expiry. The full key is returned only once at creation and must be stored immediately. A recent two-factor re-verification is required.
/ accounts. v1. Accounts/ CreateAPIKeyRequest body
application/jsonRequired
Request to create an API key in the caller's workspace. Requires an accepted membership and a two-factor step-up in the last 5 minutes. The caller is emailed a notification.
expiresAt?stringWhen the key should stop authenticating. Absent creates a key that never expires.
Format"date-time"
name?stringLabel for the key, 1 to 256 characters after trimming surrounding whitespace.
policies?array<string>Names of the policies to grant, at least one, each a name returned by ListPolicies, such as "trading" or "steam".
Response body
application/json
Success
apiKey?APIKeyThe created key's details, without the secret.
Show attributes
createdAt?stringWhen the key was created.
Format"date-time"
createdBy?stringOpaque 16-byte identifier of the user who created the key and owns it, base64-encoded in JSON.
Format"byte" base64
expiresAt?stringWhen the key stops authenticating. Requests at or after this time are rejected as unauthenticated. Absent when the key never expires.
Format"date-time"
id?stringOpaque 16-byte identifier of the API key, assigned on creation. Base64-encoded in JSON.
Format"byte" base64
keyPrefix?stringThe first 8 characters of the secret, kept so a key can be recognised in lists. Cannot authenticate on its own.
lastUsedAt?stringWhen the key last authenticated a request. Absent when the key has never been used.
Format"date-time"
name?stringLabel chosen when the key was created, 1 to 256 characters, to tell keys apart.
policies?array<string>Names of the policies granted to the key, at least one, such as "trading" or "steam". ListPolicies lists the valid names and the permissions each grants.
previousKeyExpiresAt?stringWhen the secret this key had before its last rotation stops authenticating. A time in the past means it has stopped. Absent when the key was never rotated with a grace period, or was last rotated with none.
Format"date-time"
revealable?booleanWhether RevealAPIKey can return this key's secret. False for a key created before secrets were stored. Rotate it to make it revealable.
workspaceId?stringOpaque 16-byte identifier of the workspace the key is confined to, base64-encoded in JSON.
Format"byte" base64
rawKey?stringThe key's secret, 64 hexadecimal characters, sent as a Bearer token in the Authorization header. Store it securely. RevealAPIKey can return it again after a two-factor step-up.
application/json
The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/CreateAPIKey" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "CI deploy key",
"expiresAt": "2027-06-29T00:00:00Z",
"policies": [
"trading",
"analytics"
]
}'const res = await fetch("https://api.goldmine.to/accounts.v1.Accounts/CreateAPIKey", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "CI deploy key",
"expiresAt": "2027-06-29T00:00:00Z",
"policies": [
"trading",
"analytics"
]
}),
});
const data = await res.json();body := strings.NewReader(`{
"name": "CI deploy key",
"expiresAt": "2027-06-29T00:00:00Z",
"policies": [
"trading",
"analytics"
]
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/accounts.v1.Accounts/CreateAPIKey", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/accounts.v1.Accounts/CreateAPIKey",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"name": "CI deploy key",
"expiresAt": "2027-06-29T00:00:00Z",
"policies": [
"trading",
"analytics"
]
},
)
data = res.json(){
"apiKey": {
"id": "CgsMDQ4PEBESExQVFhcYGQ==",
"name": "CI deploy key",
"keyPrefix": "gm_live_8f3a",
"workspaceId": "AAECAwQFBgcICQoLDA0ODw==",
"expiresAt": "2027-06-29T00:00:00Z",
"createdAt": "2026-06-29T12:00:00Z",
"policies": [
"trading",
"analytics"
]
},
"rawKey": "gm_live_8f3a2b1c9d4e5f60718293a4b5c6d7e8"
}{
"code": "failed_precondition",
"message": "The request cannot be carried out in the current system state."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}