# PumpSim API

## Docs

- [Buy SOL](https://docs.pumpsim.dev/api-reference/buy/buy-sol.md): Simulate a buy using an exact lamports or SOL amount.
- [Buy supply percentage](https://docs.pumpsim.dev/api-reference/buy/buy-supply-percentage.md): Simulate a buy for a percentage of total supply.
- [Buy to market cap](https://docs.pumpsim.dev/api-reference/buy/buy-to-market-cap.md): Simulate a buy up to a target market cap.
- [Buy tokens](https://docs.pumpsim.dev/api-reference/buy/buy-tokens.md): Simulate a buy for an exact raw or decimal token amount.
- [Get coin state](https://docs.pumpsim.dev/api-reference/coin/get-coin-state.md): Fetch a coin's on-chain reserves and return the equivalent simulation state and stats.
- [Close position](https://docs.pumpsim.dev/api-reference/position/close-position.md): Close a position fully by selling all of its held tokens.
- [Close position by percentage](https://docs.pumpsim.dev/api-reference/position/close-position-by-percentage.md): Close part of a position by selling a percentage of its held tokens
- [Close position by tokens](https://docs.pumpsim.dev/api-reference/position/close-position-by-tokens.md): Close part of a position by selling an exact raw or decimal token amount.
- [Get position multiplier](https://docs.pumpsim.dev/api-reference/position/get-position-multiplier.md): Get a position's return multiplier at a target market cap
- [Get position PNL](https://docs.pumpsim.dev/api-reference/position/get-position-pnl.md): Get a position's unrealized profit/loss as a decimal and a percentage.
- [Get position value](https://docs.pumpsim.dev/api-reference/position/get-position-value.md): Get what a position would be worth if closed at the given (or default) state.
- [Open position](https://docs.pumpsim.dev/api-reference/position/open-position.md): Open a trackable position by buying with an exact lamport or SOL amount.
- [Sell SOL](https://docs.pumpsim.dev/api-reference/sell/sell-sol.md): Simulate a sell targeting an exact lamport or SOL amount received.
- [Sell to market cap](https://docs.pumpsim.dev/api-reference/sell/sell-to-market-cap.md): Simulate a sell down to a target market cap.
- [Sell tokens](https://docs.pumpsim.dev/api-reference/sell/sell-tokens.md): Simulate a sell for an exact raw or decimal token amount.
- [Introduction](https://docs.pumpsim.dev/index.md): Welcome to your project
- [Quickstart](https://docs.pumpsim.dev/quickstart.md): Begin with a guide on the fastest path to a successful outcome

## OpenAPI Specs

- [openapi](https://docs.pumpsim.dev/openapi.json)