@turnkey/sdk-server

A SDK client with server-specific abstractions for interacting with Turnkey API. Also includes @turnkey/http, a lower-level, fully typed HTTP client.

Turnkey API documentation lives here: https://docs.turnkey.com.

Getting started

1$ npm install @turnkey/sdk-server

1const { Turnkey } = require("@turnkey/sdk-server");
2
3// This config contains parameters including base URLs, API credentials, and org ID
4const turnkeyConfig = JSON.parse(fs.readFileSync("./turnkey.json", "utf8"));
5
6// Use the config to instantiate a Turnkey Client
7const turnkeyServerClient = new Turnkey(turnkeyConfig);
8
9// You're all set to create a server!
10const turnkeyProxyHandler = turnkeyServerClient.expressProxyHandler({});
11
12app.post("/apiProxy", turnkeyProxyHandler);
13
14app.listen(PORT, () => {
15  console.log(`Server running on port ${PORT}`);
16});

Helpers

@turnkey/sdk-server provides Turnkey, which offers wrappers around commonly used Turnkey API setups. This enables you to easily stand up a minimal backend to proxy end-users' requests to Turnkey. You can also use this to call on the Turnkey API directly from a server setting.

// TODO: // - typescript-ify example // - include nextjs server example