Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.quantumapi.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Custody API local setup

1

Start dependencies

The Custody API requires PostgreSQL 16. Use Docker Compose from the repository root:
cd custody
docker compose up -d postgres
2

Configure environment

Copy the example environment file and adjust values:
cp .env.example .env
Key variables:
VariableDefaultDescription
DATABASE_URLpostgres://custody:custody@localhost:5432/custodyPostgreSQL connection string
HTTP_ADDR:8080API listen address
LOG_LEVELinfoLog verbosity
HMAC_SECRET—Webhook signing secret
3

Run the API

go run ./cmd/custody-api
The API will be available at http://localhost:8080/v1.

​
Documentation preview

Prerequisites:
  • Node.js version 19 or higher
  • The custody/docs directory
Follow these steps to install and run Mintlify on your operating system.
1

Install the Mintlify CLI

npm i -g mint
2

Preview locally

Navigate to your docs directory where your docs.json file is located, and run the following command:
mint dev
A local preview of your documentation will be available at http://localhost:3000.

​
Custom ports

By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the --port flag. For example, to run Mintlify on port 3333, use this command: 
mint dev --port 3333
If you attempt to run Mintlify on a port that’s already in use, it will use the next available port: 
Port 3000 is already in use. Trying 3001 instead.

​
Mintlify versions

Please note that each CLI release is associated with a specific version of Mintlify. If your local preview does not align with the production version, please update the CLI: 
npm mint update
The CLI can assist with validating links in your documentation. To identify any broken links, use the following command: 
mint broken-links

​
Deployment

If the deployment is successful, you should see the following:
Screenshot of a deployment confirmation message that says All checks have passed.

​
Code formatting

We suggest using extensions on your IDE to recognize and format MDX. If you’re a VSCode user, consider the MDX VSCode extension for syntax highlighting, and Prettier for code formatting.

​
Troubleshooting

This may be due to an outdated version of node. Try the following:
  1. Remove the currently-installed version of the CLI: npm remove -g mint
  2. Upgrade to Node v19 or higher.
  3. Reinstall the CLI: npm i -g mint
Solution: Go to the root of your device and delete the ~/.mintlify folder. Then run mint dev again.
Curious about what changed in the latest CLI version? Check out the CLI changelog.