# GetEquity

- [Introduction](https://getequity.io/docs/introduction.md): Get Equity is a private marketplace for investors and companies to trade digital securities and assets privately and securely, the platform allows companies or enterprises digitalize their assets and creates liquidity for them by connecting them to investors and syndicates who can buy and sell these…
- [Introduction](https://getequity.io/docs/api-reference/introduction.md): Welcome to the GetEquity API documentation!
- [Choosing your integration](https://getequity.io/docs/api-reference/choosing-your-integration.md): GetEquity exposes three API products. Which one you build against depends on whether you hold your own regulatory permissions, and whether you are distributing investments or issuing credit.
- [Direct model](https://getequity.io/docs/api-reference/investments/direct.md): For regulated entities that hold their own permissions and run their own ledger. You trade as your organisation and attach a customer object to each trade.
- [Overview](https://getequity.io/docs/api-reference/endpoint/Trade/trade.md): This section provides endpoints to facilitate token trading operations, allowing users to buy and sell tokens.
- [Fetch All Active Tokens](https://getequity.io/docs/api-reference/endpoint/Trade/get-tokens.md): Fetch all active tokens
- [Fetch Raising Tokens](https://getequity.io/docs/api-reference/endpoint/Trade/get-raising-tokens.md): Fetch all tokens currently in a fundraising round
- [Buy token](https://getequity.io/docs/api-reference/endpoint/Trade/buy-token.md): Allows an api client purchase token on the GE platform
- [Fund and Buy](https://getequity.io/docs/api-reference/endpoint/Trade/fund-buy.md): Initiates a fund-and-buy transaction for an api client. This creates a payment (card or bank transfer) that funds the wallet and buys a token in a single flow.
- [Sell token](https://getequity.io/docs/api-reference/endpoint/Trade/sell-token.md): This endpoint allows you to sell a token with the specified ID
- [Get Asset](https://getequity.io/docs/api-reference/endpoint/Trade/get-asset.md): Allows an api client get details of an asset
- [Get Token](https://getequity.io/docs/api-reference/endpoint/Trade/get-token.md): Fetch a specific token by its ID
- [Token Historicals](https://getequity.io/docs/api-reference/endpoint/Trade/token-historicals.md): Fetch historical daily price and volume (OHLCV) data for a token
- [Search Token](https://getequity.io/docs/api-reference/endpoint/Trade/search-token.md): Search for tokens based on various criteria
- [Bid into an offering](https://getequity.io/docs/api-reference/endpoint/Trade/commit-to-offering.md): Commit funds to an offering on behalf of a customer
- [Fetch the order book](https://getequity.io/docs/api-reference/endpoint/Trade/offering-book.md): Aggregate demand, cover and the demand ladder
- [Amend a bid](https://getequity.io/docs/api-reference/endpoint/Trade/amend-commitment.md): Change the amount or limit on a live bid
- [Withdraw a bid](https://getequity.io/docs/api-reference/endpoint/Trade/withdraw-commitment.md): Pull a bid and release the held funds
- [List your bids](https://getequity.io/docs/api-reference/endpoint/Trade/list-commitments.md): Every bid you have placed, with its outcome
- [Overview](https://getequity.io/docs/api-reference/endpoint/Customers/customers.md): This section provides endpoints to manage customer data and retrieve customer information
- [Fetch All Customers](https://getequity.io/docs/api-reference/endpoint/Customers/get-customers.md): Returns a paginated list of all customers of an api client.
- [Search For a Customer](https://getequity.io/docs/api-reference/endpoint/Customers/search-customers.md): Search for a customer by name or email
- [Overview](https://getequity.io/docs/api-reference/endpoint/Orders/orders.md): This section facilitates the management of trade transactions and provides endpoints to retrieve order details.
- [Fetch Active Buy Orders](https://getequity.io/docs/api-reference/endpoint/Orders/get-buy-orders.md): Fetch all active buy orders
- [Fetch Active Sell Orders](https://getequity.io/docs/api-reference/endpoint/Orders/get-sell-orders.md): Fetch all active sell orders
- [Fetch an Order](https://getequity.io/docs/api-reference/endpoint/Orders/get-order.md): Gets a single order details by its ID
- [Cancel an Order](https://getequity.io/docs/api-reference/endpoint/Orders/cancel-order.md): Cancel an order owned by the API client
- [Overview](https://getequity.io/docs/api-reference/endpoint/Transactions/transactions.md): This section manages the necessary APIs for handling wallet transactions.
- [Fetch a transaction / verify a payment](https://getequity.io/docs/api-reference/endpoint/Transactions/get-transaction.md): Look up a transaction by the reference we issued, or by its id, and find out whether the payment went through
- [Fetch Customer Transactions](https://getequity.io/docs/api-reference/endpoint/Transactions/get-customer-transactions.md): Fetch all transactions for a customer by customer's email
- [Fetch Total Transaction Volume](https://getequity.io/docs/api-reference/endpoint/Transactions/get-total-transaction-volume.md): Gets all the transaction carried out on an Api client's account
- [Overview](https://getequity.io/docs/api-reference/endpoint/Wallet/wallet.md): This section provides endpoints to manage your organisation wallet and retrieve its balances.
- [Fund wallet](https://getequity.io/docs/api-reference/endpoint/Wallet/fund-wallet.md): Initiate a payment to fund your wallet
- [Withdraw from wallet](https://getequity.io/docs/api-reference/endpoint/Wallet/withdraw.md): Debit the calling organisation's own currency wallet to a bank account
- [Get All Currencies Wallet Balance](https://getequity.io/docs/api-reference/endpoint/Wallet/get-currencies-balance.md): This endpoint is used to retrieve the balance and value of different currencies.
- [Fetch Wallet Balance](https://getequity.io/docs/api-reference/endpoint/Wallet/get-wallet-balance.md): This endpoint retrieves your balance information for a specific token via its symbol.
- [Refresh Wallet Balance](https://getequity.io/docs/api-reference/endpoint/Wallet/refresh-wallet-balance.md): This endpoint is used in sandbox mode only, to enable you adequately have funds in your balance for transactions
- [Managed model](https://getequity.io/docs/api-reference/investments/managed.md): For non-regulated entities acting as an intermediary between their users and GetEquity. Each of your users gets a real GetEquity account — a member — that you act on behalf of.
- [Overview](https://getequity.io/docs/api-reference/endpoint/Members/members.md): This section handles the essential APIs for processing transactions on behalf of users, representing them as members of your GetEquity syndicate.
- [Create Member](https://getequity.io/docs/api-reference/endpoint/Members/create-member.md): Provision a member of your organisation's syndicate
- [Get Members](https://getequity.io/docs/api-reference/endpoint/Members/get-members.md): Get members of an Organisanisation's syndicate
- [Get member by email](https://getequity.io/docs/api-reference/endpoint/Members/get-member-by-email.md): Fetch a single member of your organisation by their email address
- [Get member balance](https://getequity.io/docs/api-reference/endpoint/Members/member-currency-balance.md): Get a user's wallet balance across all available currencies
- [Get Member token balance](https://getequity.io/docs/api-reference/endpoint/Members/member-token-balance.md): Get a user's balance across all available tokens
- [Get Member transactions](https://getequity.io/docs/api-reference/endpoint/Members/member-transactions.md): Get a user's transactions on the getequity platform
- [Get member orders](https://getequity.io/docs/api-reference/endpoint/Members/member-orders.md): Get a user's orders on the getequity platform
- [Buy token as member](https://getequity.io/docs/api-reference/endpoint/Members/buy-token.md): Buy token as member of an organisation
- [Fund and Invest](https://getequity.io/docs/api-reference/endpoint/Members/fund-invest.md): Initiates a fund-and-invest transaction for a member. This creates a payment link that the member can use to fund their wallet and invest in a token in a single flow.
- [Get Fund and Invest Quote](https://getequity.io/docs/api-reference/endpoint/Members/fund-invest-quote.md): Get a preview of fees for a fund-and-invest transaction without initiating payment.
- [Sell token as member](https://getequity.io/docs/api-reference/endpoint/Members/sell-token.md): Sell token as member of an organisation
- [Fund member wallet](https://getequity.io/docs/api-reference/endpoint/Members/fund-member-wallet.md): Initiate a payment to fund a member's wallet
- [Withdraw from member wallet](https://getequity.io/docs/api-reference/endpoint/Members/withdraw-member-wallet.md): Debit a member's currency wallet to a bank account
- [Cancel a member order](https://getequity.io/docs/api-reference/endpoint/Members/cancel-member-order.md): Cancel an order owned by a member of the API client
- [Bid into an offering for a member](https://getequity.io/docs/api-reference/endpoint/Members/member-commit-to-offering.md): Place a bid on behalf of one of your members
- [Overview](https://getequity.io/docs/api-reference/endpoint/CreditLoan/credit-loan.md): For credit providers. Issue and service loans to GetEquity users against the investments they already hold, using their portfolio as collateral.
- [Get Loan Configuration](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-loan-configuration.md): Retrieves the current loan configuration for the authenticated creditor.
- [Get User by ID](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-user-by-id.md): Retrieves details about a user.
- [Get User Investments](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-user-investments.md): Retrieves the investments that belong to a user.
- [Create Loan](https://getequity.io/docs/api-reference/endpoint/CreditLoan/create-loan.md): Creates a new loan using specified collateral against a matched loan configuration.
- [Get Loans By Creditor](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-creditor-loans.md): Retrieves all loans for the authenticated creditor with pagination support.
- [Get Loan By ID](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-loan-by-id.md): Fetches a single loan using its ID.
- [Repay Loan](https://getequity.io/docs/api-reference/endpoint/CreditLoan/repay-loan.md): Creates a new loan using specified collateral against a matched loan configuration.
- [Overview](https://getequity.io/docs/api-reference/endpoint/Webhook/webhook.md)
- [member.created](https://getequity.io/docs/api-reference/endpoint/Webhook/member-created.md): Triggered when a new dealroom user is provisioned under your organisation.
- [order.created](https://getequity.io/docs/api-reference/endpoint/Webhook/order-created.md): Triggered when a Buy or Sell order is created on the exchange.
- [order.cancelled](https://getequity.io/docs/api-reference/endpoint/Webhook/order-cancelled.md): Triggered when an order is cancelled.
- [transaction.created](https://getequity.io/docs/api-reference/endpoint/Webhook/transaction-created.md): Triggered when a buy/sell match is fulfilled on the exchange.
- [wallet.funded](https://getequity.io/docs/api-reference/endpoint/Webhook/wallet-funded.md): Triggered when a successful wallet topup payment is processed.
- [listing.created](https://getequity.io/docs/api-reference/endpoint/Webhook/listing-created.md): Triggered when a token created from an approved token request is persisted.
- [token.transferred](https://getequity.io/docs/api-reference/endpoint/Webhook/token-transferred.md): Triggered on blockchain token send/receive transfers.
- [withdrawal.created](https://getequity.io/docs/api-reference/endpoint/Webhook/withdrawal-created.md): Triggered when a user creates a withdrawal request.
- [withdrawal.approved](https://getequity.io/docs/api-reference/endpoint/Webhook/withdrawal-approved.md): Triggered when an admin approves a withdrawal request.
- [loan.created](https://getequity.io/docs/api-reference/endpoint/Webhook/loan-created.md): Triggered when a user takes a loan.
- [loan.repaid](https://getequity.io/docs/api-reference/endpoint/Webhook/loan-repaid.md): Triggered when a loan is fully repaid.
- [esop.transferred](https://getequity.io/docs/api-reference/endpoint/Webhook/esop-transferred.md): Triggered when an ESOP stock transfer is approved.
- [token.gifted](https://getequity.io/docs/api-reference/endpoint/Webhook/token-gifted.md): Triggered when a sender gifts tokens to another user.
- [token.gift.accepted](https://getequity.io/docs/api-reference/endpoint/Webhook/token-gift-accepted.md): Triggered when the receiver accepts a token gift.
- [On-Chain Overview](https://getequity.io/docs/onchain/introduction.md): How to trade RWA (Real-World Asset) tokens directly against the smart contracts on Ethereum (Base) and Solana.
- [Yield & Accrual](https://getequity.io/docs/onchain/yield-and-accrual.md): How debt and fund tokens earn: the price accretes every second, balances never change, and nothing is paid on a schedule.
- [Credit Overview](https://getequity.io/docs/onchain/credit.md): Borrow cNGN against RWA tokens you hold, or lend cNGN to earn the interest borrowers pay. Morpho Blue on Base, Kamino Lend on Solana.
- [Credit on Base (Morpho Blue)](https://getequity.io/docs/onchain/credit-base.md): Borrow cNGN against gNTB, or lend cNGN, through Morpho Blue on Base.
- [Credit on Solana (Kamino Lend)](https://getequity.io/docs/onchain/credit-solana.md): Borrow cNGN against gNTB, or lend cNGN, through Kamino Lend on Solana.
- [Market-Making Pools](https://getequity.io/docs/onchain/market-making.md): How the per-asset venue lets approved market makers create and redeem stock with the vault, and quote investors a two-way price.
- [Become a Market Maker](https://getequity.io/docs/onchain/become-a-market-maker.md): Get approved as a market maker, set up your wallet, and create, redeem and quote through the venue on Base and Solana.
- [Ethereum (Base) — Addresses](https://getequity.io/docs/onchain/ethereum-addresses.md): The contract addresses you need to trade RWA tokens on Base.
- [Ethereum (Base) — Trading](https://getequity.io/docs/onchain/ethereum-contracts.md): The Market and token functions you call to quote, buy, sell, and claim payouts on Base.
- [Solana — Programs & Addresses](https://getequity.io/docs/onchain/solana-addresses.md): The program IDs, PDAs, and mint addresses you need to trade RWA tokens on Solana.
- [Solana — Trading](https://getequity.io/docs/onchain/solana-programs.md): The rwa_market instructions you call to quote, buy, sell, and redeem RWA tokens on Solana.
- [Cross-Chain Quick Reference](https://getequity.io/docs/onchain/cross-chain-reference.md): Trading concepts side-by-side across Ethereum (Base) and Solana.
- [Change Log](https://getequity.io/docs/change-log/change-log.md): Notable changes to the GetEquity API documentation.

## Optional

- [Blog](https://www.getequity.io/blog)
- [FAQs](https://www.getequity.io/faq/)
- [Support](mailto:support@getequity.io)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.