---
title: "Reference"
canonical: "https://fragment.dev/api-reference"
---

# Reference

Source: https://fragment.dev/api-reference

[Documentation index](https://fragment.dev/llms.txt)

<a id="api-reference"></a>

Fragment exposes a GraphQL API to write and read your data. GraphQL uses a schema definition file to describe mutations and queries available in the API. This file is hosted at:

```bash
https://api.fragment.dev/schema.graphql
```

To call the API, use Fragment's [SDKs](https://fragment.dev/docs/embed-in-ci.md).

## [API Overview](https://fragment.dev/api-reference/ledger-overview.md)

- [Regions](https://fragment.dev/api-reference/ledger-overview.md#regions)
- [Authentication](https://fragment.dev/api-reference/ledger-overview.md#authentication)
- [Idempotency](https://fragment.dev/api-reference/ledger-overview.md#idempotency)
- [Errors](https://fragment.dev/api-reference/ledger-overview.md#errors)

## [API Queries](https://fragment.dev/api-reference/ledger-queries.md)

- [customCurrencies](https://fragment.dev/api-reference/ledger-queries.md#customcurrencies)
- [externalAccount](https://fragment.dev/api-reference/ledger-queries.md#externalaccount)
- [ledger](https://fragment.dev/api-reference/ledger-queries.md#ledger)
- [ledgerAccount](https://fragment.dev/api-reference/ledger-queries.md#ledgeraccount)
- [ledgerAccountBalances](https://fragment.dev/api-reference/ledger-queries.md#ledgeraccountbalances)
- [ledgerEntry](https://fragment.dev/api-reference/ledger-queries.md#ledgerentry)
- [ledgerEntryGroup](https://fragment.dev/api-reference/ledger-queries.md#ledgerentrygroup)
- [ledgerEntryHistory](https://fragment.dev/api-reference/ledger-queries.md#ledgerentryhistory)
- [ledgerLine](https://fragment.dev/api-reference/ledger-queries.md#ledgerline)
- [ledgers](https://fragment.dev/api-reference/ledger-queries.md#ledgers)
- [link](https://fragment.dev/api-reference/ledger-queries.md#link)
- [links](https://fragment.dev/api-reference/ledger-queries.md#links)
- [payment](https://fragment.dev/api-reference/ledger-queries.md#payment)
- [paymentMethod](https://fragment.dev/api-reference/ledger-queries.md#paymentmethod)
- [paymentMethodSetup](https://fragment.dev/api-reference/ledger-queries.md#paymentmethodsetup)
- [paymentMethods](https://fragment.dev/api-reference/ledger-queries.md#paymentmethods)
- [schema](https://fragment.dev/api-reference/ledger-queries.md#schema)
- [schemas](https://fragment.dev/api-reference/ledger-queries.md#schemas)
- [tx](https://fragment.dev/api-reference/ledger-queries.md#tx)
- [webhookSubscriptions](https://fragment.dev/api-reference/ledger-queries.md#webhooksubscriptions)
- [workspace](https://fragment.dev/api-reference/ledger-queries.md#workspace)

## [API Mutations](https://fragment.dev/api-reference/ledger-mutations.md)

- [addLedgerEntries](https://fragment.dev/api-reference/ledger-mutations.md#addledgerentries)
- [addLedgerEntry](https://fragment.dev/api-reference/ledger-mutations.md#addledgerentry)
- [createCustomCurrency](https://fragment.dev/api-reference/ledger-mutations.md#createcustomcurrency)
- [createCustomLink](https://fragment.dev/api-reference/ledger-mutations.md#createcustomlink)
- [createLedger](https://fragment.dev/api-reference/ledger-mutations.md#createledger)
- [createPayment](https://fragment.dev/api-reference/ledger-mutations.md#createpayment)
- [createPaymentMethodSetup](https://fragment.dev/api-reference/ledger-mutations.md#createpaymentmethodsetup)
- [createWebhookSubscription](https://fragment.dev/api-reference/ledger-mutations.md#createwebhooksubscription)
- [deleteCustomTxs](https://fragment.dev/api-reference/ledger-mutations.md#deletecustomtxs)
- [deleteLedger](https://fragment.dev/api-reference/ledger-mutations.md#deleteledger)
- [deletePaymentMethod](https://fragment.dev/api-reference/ledger-mutations.md#deletepaymentmethod)
- [deleteSchema](https://fragment.dev/api-reference/ledger-mutations.md#deleteschema)
- [deleteWebhookSubscription](https://fragment.dev/api-reference/ledger-mutations.md#deletewebhooksubscription)
- [instantiateLedgerAccount](https://fragment.dev/api-reference/ledger-mutations.md#instantiateledgeraccount)
- [migrateLedgerEntry](https://fragment.dev/api-reference/ledger-mutations.md#migrateledgerentry)
- [reconcileTx](https://fragment.dev/api-reference/ledger-mutations.md#reconciletx)
- [refundPayment](https://fragment.dev/api-reference/ledger-mutations.md#refundpayment)
- [retryPayment](https://fragment.dev/api-reference/ledger-mutations.md#retrypayment)
- [reverseLedgerEntry](https://fragment.dev/api-reference/ledger-mutations.md#reverseledgerentry)
- [storeSchema](https://fragment.dev/api-reference/ledger-mutations.md#storeschema)
- [syncCustomAccounts](https://fragment.dev/api-reference/ledger-mutations.md#synccustomaccounts)
- [syncCustomTxs](https://fragment.dev/api-reference/ledger-mutations.md#synccustomtxs)
- [updateLedger](https://fragment.dev/api-reference/ledger-mutations.md#updateledger)
- [updateLedgerEntry](https://fragment.dev/api-reference/ledger-mutations.md#updateledgerentry)

## [API Types](https://fragment.dev/api-reference/ledger-types.md)

- [MatchInput Types](https://fragment.dev/api-reference/ledger-types.md#matchinput-types)
- [Core Types](https://fragment.dev/api-reference/ledger-types.md#core-types)
- [Scalars and Enums](https://fragment.dev/api-reference/ledger-types.md#scalars-and-enums)
- [Input Types](https://fragment.dev/api-reference/ledger-types.md#input-types)
- [Response Types](https://fragment.dev/api-reference/ledger-types.md#response-types)
- [Result Types](https://fragment.dev/api-reference/ledger-types.md#result-types)
- [Error Types](https://fragment.dev/api-reference/ledger-types.md#error-types)
- [Connection Types](https://fragment.dev/api-reference/ledger-types.md#connection-types)
- [Filter Types](https://fragment.dev/api-reference/ledger-types.md#filter-types)
- [Utility Types](https://fragment.dev/api-reference/ledger-types.md#utility-types)

## [CLI Commands](https://fragment.dev/api-reference/ledger-cli-commands.md)

- [login](https://fragment.dev/api-reference/ledger-cli-commands.md#login)
- [store-schema](https://fragment.dev/api-reference/ledger-cli-commands.md#store-schema)
- [create-ledger](https://fragment.dev/api-reference/ledger-cli-commands.md#create-ledger)
- [get-schema](https://fragment.dev/api-reference/ledger-cli-commands.md#get-schema)
- [add-ledger-entry](https://fragment.dev/api-reference/ledger-cli-commands.md#add-ledger-entry)
- [create-custom-link](https://fragment.dev/api-reference/ledger-cli-commands.md#create-custom-link)
- [delete-custom-txs](https://fragment.dev/api-reference/ledger-cli-commands.md#delete-custom-txs)
- [delete-ledger](https://fragment.dev/api-reference/ledger-cli-commands.md#delete-ledger)
- [delete-schema](https://fragment.dev/api-reference/ledger-cli-commands.md#delete-schema)
- [gen-graphql](https://fragment.dev/api-reference/ledger-cli-commands.md#gen-graphql)
- [reverse-ledger-entry](https://fragment.dev/api-reference/ledger-cli-commands.md#reverse-ledger-entry)
- [update](https://fragment.dev/api-reference/ledger-cli-commands.md#update)
- [token](https://fragment.dev/api-reference/ledger-cli-commands.md#token)
- [help](https://fragment.dev/api-reference/ledger-cli-commands.md#help)
- [workspace](https://fragment.dev/api-reference/ledger-cli-commands.md#workspace)
