Turnkey

https://docs.turnkey.com/
Admin
Turnkey provides a complete and ready-to-use platform or service, offering comprehensive solutions...
Tokens:2,120,897
Snippets:14,870
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install dependencies for vaults.fyi example

Source: https://docs.turnkey.com/llms-full.txt

Installs the required dependencies for the vaults.fyi integration example.

```bash
npm install @turnkey/viem @turnkey/sdk-server @vaultsfyi/sdk viem
```

--------------------------------

### Clone and install dependencies

Source: https://docs.turnkey.com/llms-full.txt

Clones the example repository and installs its dependencies.

```bash
git clone https://github.com/Polymarket/turnkey-safe-builder-example.git
npm install
```

--------------------------------

### Install the Turnkey Go SDK with go get

Source: https://docs.turnkey.com/solutions/company-wallets/integration-guide/golang

Run this command from inside a Go module to install the `github.com/tkhq/go-sdk/v2` package.

```bash
go get github.com/tkhq/go-sdk/v2

```

--------------------------------

### Install @turnkey/sdk-server with @turnkey/viem or @turnkey/ethers

Source: https://docs.turnkey.com/solutions/company-wallets/quickstart

Install the Turnkey server SDK and the Ethereum library of your choice. Use the Viem command for Viem-based development or the Ethers command for Ethers-based development; these are alternative setups, not both required.

```bash
npm install @turnkey/sdk-server @turnkey/viem viem

```

```bash
npm install @turnkey/sdk-server @turnkey/ethers ethers

```

--------------------------------

### Install required packages for Turnkey 0x swap example

Source: https://docs.turnkey.com/solutions/cookbooks/0x

Install the required packages for using Turnkey with 0x swaps. This includes the Turnkey React wallet kit, Viem integration, and Viem/Wagmi libraries.

```shell
npm install @turnkey/react-wallet-kit @turnkey/viem viem wagmi

```

--------------------------------

### Quick authentication with handleLogin

Source: https://docs.turnkey.com/solutions/embedded-wallets/integration-guide/react/auth

Use the handleLogin function from the useTurnkey hook to trigger a login or signup modal with all configured authentication methods. This example is from the quick start guide and renders a button that opens the modal when clicked.

```tsx
"use client";
import { useTurnkey } from "@turnkey/react-wallet-kit";

function LoginButton() {
  const { handleLogin } = useTurnkey();
  return <button onClick={handleLogin}>Login / Sign Up</button>;
}
export default function Home() {
  return (
    <LoginButton /> 
  );
}

```

--------------------------------

### Get Sub-Organizations: cURL and JavaScript SDK request examples

Source: https://docs.turnkey.com/llms-full.txt

Request examples for the Get Sub-Organizations query. The cURL example posts to the /public/v1/query/list_suborgs endpoint with the required headers and JSON body. The JavaScript example uses the Turnkey SDK server client to call getSubOrgIds with the same parameters.

```bash
curl --request POST \
    --url https://api.turnkey.com/public/v1/query/list_suborgs \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header "X-Stamp: <string> (see Authorizations)" \
    --data '{
      "organizationId": "<string>",
      "filterType": "<string>",
      "filterValue": "<string>",
      "paginationOptions": {
          "limit": "<string>",
          "before": "<string>",
          "after": "<string>"
      }
  }'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getSubOrgIds({
  organizationId: "<string> (Unique identifier for the parent organization. This is used to find sub-organizations within it.)",
  filterType: "<string> (Specifies the type of filter to apply, i.e 'CREDENTIAL_ID', 'NAME', 'USERNAME', 'EMAIL', 'PHONE_NUMBER', 'OIDC_TOKEN', 'WALLET_ACCOUNT_ADDRESS' or 'PUBLIC_KEY')",
  filterValue: "<string> (The value of the filter to apply for the specified type. For example, a specific email or name string.)",
  paginationOptions: { // paginationOptions field,
    limit: "<string> (A limit of the number of object to be returned, between 1 and 100. Defaults to 10.)",
    before: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects before this ID.)",
    after: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects after this ID.)",
  }
});
```

--------------------------------

### Install Turnkey viem and server SDK

Source: https://docs.turnkey.com/solutions/cookbooks/base-builder-codes

Install the Turnkey viem and server SDK packages needed to create a Turnkey signer with attribution.

```bash
npm i @turnkey/viem @turnkey/sdk-server

```

```bash
pnpm add @turnkey/viem @turnkey/sdk-server

```

```bash
yarn add @turnkey/viem @turnkey/sdk-server

```

--------------------------------

### Get policy evaluations request examples (cURL and JavaScript)

Source: https://docs.turnkey.com/llms-full.txt

Request examples for the Get Policy Evaluations query. The cURL example posts to the /public/v1/query/get_policy_evaluations endpoint with an X-Stamp header for authorization. The JavaScript example uses the Turnkey SDK server client and requires API_PUBLIC_KEY, API_PRIVATE_KEY, and ORGANIZATION_ID environment variables.

```bash
curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_policy_evaluations \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "activityId": "<string>"
}'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getPolicyEvaluations({
  organizationId: "<string> (Unique identifier for a given organization.)",
  activityId: "<string> (Unique identifier for a given activity.)"
});
```

--------------------------------

### Initialize the Turnkey client

Source: https://docs.turnkey.com/llms-full.txt

Set up the Turnkey client by adding API credentials to a .env file and initializing the client with the @turnkey/sdk-server package. The .env file must contain the organization ID and API private/public keys.

```bash
TURNKEY_ORGANIZATION_ID=<your-organization-id>
TURNKEY_API_PRIVATE_KEY=<your-api-private-key>
TURNKEY_API_PUBLIC_KEY=<your-api-public-key>
```

```ts
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID!,
  apiPrivateKey: process.env.TURNKEY_API_PRIVATE_KEY!,
  apiPublicKey: process.env.TURNKEY_API_PUBLIC_KEY!,
});
```

--------------------------------

### Get Nonces request examples (cURL and JavaScript)

Source: https://docs.turnkey.com/llms-full.txt

Request examples for the Get Nonces query. The cURL command posts to /public/v1/query/get_nonces with an X-Stamp header for authorization. The JavaScript example uses the Turnkey SDK server client and calls getNonces with the same parameters.

```bash
curl --request POST \
    --url https://api.turnkey.com/public/v1/query/get_nonces \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header "X-Stamp: <string> (see Authorizations)" \
    --data '{
      "organizationId": "<string>",
      "address": "<string>",
      "caip2": "<eip155:1>",
      "nonce": "<boolean>",
      "gasStationNonce": "<boolean>"
  }'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getNonces({
  organizationId: "<string> (Unique identifier for a given Organization.)",
  address: "<string> (The Ethereum address to query nonces for.)",
  caip2: "<eip155:1>" // CAIP-2 chain ID (e.g., 'eip155:1' for Ethereum mainnet).,
  nonce: true // Whether to fetch the standard on-chain nonce.,
  gasStationNonce: true // Whether to fetch the gas station nonce used for sponsored transactions.
});
```

--------------------------------

### Get session profiles request examples (cURL and JavaScript)

Source: https://docs.turnkey.com/llms-full.txt

Request examples for the Get session profiles query. The cURL example sends a POST request to the endpoint with an organizationId in the body. The JavaScript example uses the Turnkey SDK server client to call getSessionProfiles, requiring API keys and an organization ID from environment variables.

```bash
curl --request POST \
    --url https://api.turnkey.com/public/v1/query/get_session_profiles \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header "X-Stamp: <string> (see Authorizations)" \
    --data '{
      "organizationId": "<string>"
  }'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getSessionProfiles({
  organizationId: "<string> (Unique identifier for a given organization.)"
});
```

--------------------------------

### Install Turnkey Go SDK

Source: https://docs.turnkey.com/llms-full.txt

Install the Turnkey Go SDK from inside a Go module.

```bash
go get github.com/tkhq/go-sdk/v2
```

--------------------------------

### Get Policy request examples (cURL and JavaScript)

Source: https://docs.turnkey.com/llms-full.txt

Request examples for the Get Policy query. The cURL example sends a POST to /public/v1/query/get_policy with organizationId and policyId in the JSON body. The JavaScript example uses the Turnkey SDK server client, initializing with API keys and default organization from environment variables, then calls getPolicy with the same parameters.

```bash
curl --request POST \
    --url https://api.turnkey.com/public/v1/query/get_policy \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header "X-Stamp: <string> (see Authorizations)" \
    --data '{
      "organizationId": "<string>",
      "policyId": "<string>"
  }'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getPolicy({
  organizationId: "<string> (Unique identifier for a given organization.)",
  policyId: "<string> (Unique identifier for a given policy.)"
});
```

--------------------------------

### Get Wallet Account API request (cURL and JavaScript)

Source: https://docs.turnkey.com/llms-full.txt

Request examples for the Turnkey Get Wallet Account API. The cURL example posts to the /public/v1/query/get_wallet_account endpoint with an X-Stamp header for authorization. The JavaScript example uses the @turnkey/sdk-server client and requires API_PUBLIC_KEY, API_PRIVATE_KEY, and ORGANIZATION_ID environment variables.

```bash
curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_wallet_account \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "walletId": "<string>",
    "address": "<string>",
    "path": "<string>"
}'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getWalletAccount({
  organizationId: "<string> (Unique identifier for a given organization.)",
  walletId: "<string> (Unique identifier for a given wallet.)",
  address: "<string> (Address corresponding to a wallet account.)",
  path: "<string> (Path corresponding to a wallet account.)"
});
```

--------------------------------

### Install @turnkey/sdk-server

Source: https://docs.turnkey.com/features/authentication/email-delivery-events

Install the Turnkey server SDK package to use the listEmailEvents API.

```bash
npm install @turnkey/sdk-server

```

--------------------------------

### Install @turnkey/core

Source: https://docs.turnkey.com/llms-full.txt

Install the Turnkey Core SDK using npm, pnpm, or yarn.

```bash
npm install @turnkey/core
```

```bash
pnpm add @turnkey/core
```

```bash
yarn add @turnkey/core
```

--------------------------------

### Get Earn claim rewards status request examples

Source: https://docs.turnkey.com/llms-full.txt

Request examples for the Get Earn claim rewards status query. The cURL command posts to the public query endpoint with an X-Stamp header for authorization. The JavaScript example uses the Turnkey SDK server client to call getEarnClaimRewardsStatus with the organizationId and claimRequestId parameters.

```bash
curl --request POST \
    --url https://api.turnkey.com/public/v1/query/get_earn_claim_rewards_status \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header "X-Stamp: <string> (see Authorizations)" \
    --data '{
      "organizationId": "<string>",
      "claimRequestId": "<string>"
  }'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getEarnClaimRewardsStatus({
  organizationId: "<string> (Unique identifier for a given Organization.)",
  claimRequestId: "<string> (The claim_request_id returned by EarnClaimRewards.)"
});
```

--------------------------------

### Install dependencies for Breeze with Turnkey

Source: https://docs.turnkey.com/solutions/cookbooks/breeze

Install the required packages: `@turnkey/react-wallet-kit`, `@turnkey/solana`, `@breezebaby/breeze-sdk`, and `@solana/web3.js`.

```bash
npm install @turnkey/react-wallet-kit @turnkey/solana @breezebaby/breeze-sdk @solana/web3.js

```

--------------------------------

### Get Gas Usage Request (cURL and JavaScript)

Source: https://docs.turnkey.com/llms-full.txt

Request example for the Get Gas Usage query. The cURL command posts to the /public/v1/query/get_gas_usage endpoint with an organizationId. The JavaScript example uses the Turnkey SDK server client to call getGasUsage with the same organizationId.

```bash
curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_gas_usage \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>"
}'
```

```javascript
import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getGasUsage({
  organizationId: "<string> (Unique identifier for a given Organization.)"
});
```

--------------------------------

### Install Turnkey and Li.Fi dependencies

Source: https://docs.turnkey.com/solutions/cookbooks/lifi

Install the required packages for integrating Turnkey with Li.Fi, including the React wallet kit, Viem and Solana adapters, and the Solana web3 library.

```bash
npm install @turnkey/react-wallet-kit @turnkey/viem @turnkey/solana viem wagmi @solana/web3.js
```

--------------------------------

### Get policy evaluations 200 response example

Source: https://docs.turnkey.com/llms-full.txt

Example 200 response for the Get Policy Evaluations query. The response contains a policyEvaluations array with fields for id, activityId, organizationId, voteId, nested policyEvaluations (policyId and outcome), and createdAt (seconds and nanos).

```json
{
  "policyEvaluations": [
    {
      "id": "<string>",
      "activityId": "<string>",
      "organizationId": "<string>",
      "voteId": "<string>",
      "policyEvaluations": [
        {
          "policyId": "<string>",
          "outcome": "<OUTCOME_ALLOW>"
        }
      ],
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    }
  ]
}
```
Tokens:
Raw