# Fairground

## Docs

- [GetADL](https://docs.fairground.fi/api-reference/adlservice/getadl.md)
- [GetLiquidationPricePreview](https://docs.fairground.fi/api-reference/liquidationservice/getliquidationpricepreview.md)
- [GetLiquidations](https://docs.fairground.fi/api-reference/liquidationservice/getliquidations.md)
- [GetMarketConfigs](https://docs.fairground.fi/api-reference/marketservice/getmarketconfigs.md)
- [GetMarketIdByName](https://docs.fairground.fi/api-reference/marketservice/getmarketidbyname.md)
- [GetMarkets](https://docs.fairground.fi/api-reference/marketservice/getmarkets.md)
- [GetMarketSummary](https://docs.fairground.fi/api-reference/marketservice/getmarketsummary.md)
- [GetOrderBook](https://docs.fairground.fi/api-reference/orderbookservice/getorderbook.md)
- [GetEstimatedFees](https://docs.fairground.fi/api-reference/orderservice/getestimatedfees.md)
- [GetOrder](https://docs.fairground.fi/api-reference/orderservice/getorder.md)
- [GetOrders](https://docs.fairground.fi/api-reference/orderservice/getorders.md)
- [GetTradeHistory](https://docs.fairground.fi/api-reference/orderservice/gettradehistory.md)
- [GenerateApiKey](https://docs.fairground.fi/api-reference/permissionservice/generateapikey.md)
- [GetPortfolio](https://docs.fairground.fi/api-reference/portfolioservice/getportfolio.md): Get portfolio for a specific owner
- [GetUserActivity](https://docs.fairground.fi/api-reference/portfolioservice/getuseractivity.md): Get aggregated user activity data for a given time-range
- [GetOpenPositions](https://docs.fairground.fi/api-reference/positionservice/getopenpositions.md)
- [GetPositionFeeInfo](https://docs.fairground.fi/api-reference/positionservice/getpositionfeeinfo.md)
- [GetHistoricalPrices](https://docs.fairground.fi/api-reference/priceservice/gethistoricalprices.md)
- [GetPrice](https://docs.fairground.fi/api-reference/priceservice/getprice.md)
- [API Reference](https://docs.fairground.fi/developers/api-overview.md): Integrate with Fairground via REST API
- [Introduction](https://docs.fairground.fi/developers/api-reference/introduction.md): Fairground API reference and integration guide
- [Error Selector Reference](https://docs.fairground.fi/developers/error-selector-reference.md): Decode on-chain revert reasons from their 4-byte hex.
- [Overview](https://docs.fairground.fi/developers/overview.md): Integrate with Fairground: REST API, client SDKs, and on-chain error lookup.
- [SDK Reference](https://docs.fairground.fi/developers/sdk-overview.md): Integrate with Fairground via SDK
- [Introduction](https://docs.fairground.fi/developers/sdk-reference/introduction.md): Client libraries for Fairground — Python and TypeScript.
- [Data Objects Reference](https://docs.fairground.fi/developers/sdk-reference/python/data-objects.md): This document provides detailed information about the data objects used in the Perpetuals SDK.
- [Data Retrieval Guide](https://docs.fairground.fi/developers/sdk-reference/python/data-retrieval.md): This document provides comprehensive information about retrieving data using the Perpetuals SDK.
- [Python SDK Overview](https://docs.fairground.fi/developers/sdk-reference/python/overview.md): Install the Fairground Python SDK and choose async or sync clients.
- [addMargin](https://docs.fairground.fi/developers/sdk-reference/python/reference/add-margin.md): Python SDK reference for addMargin.
- [cancelOpenOrder](https://docs.fairground.fi/developers/sdk-reference/python/reference/cancel-open-order.md): Python SDK reference for cancelOpenOrder.
- [cancelOrdersBatch](https://docs.fairground.fi/developers/sdk-reference/python/reference/cancel-orders-batch.md): Python SDK reference for cancelOrdersBatch.
- [closePosition](https://docs.fairground.fi/developers/sdk-reference/python/reference/close-position.md): Python SDK reference for closePosition.
- [createMarket](https://docs.fairground.fi/developers/sdk-reference/python/reference/create-market.md): Python SDK reference for createMarket.
- [extractMargin](https://docs.fairground.fi/developers/sdk-reference/python/reference/extract-margin.md): Python SDK reference for extractMargin.
- [get_error_message](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-error-message.md): Python SDK reference for get_error_message.
- [getMarketConfig](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-market-config.md): Python SDK reference for getMarketConfig.
- [getMarketSummary](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-market-summary.md): Python SDK reference for getMarketSummary.
- [getMarkets](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-markets.md): Python SDK reference for getMarkets.
- [getOpenPositions](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-open-positions.md): Python SDK reference for getOpenPositions.
- [getOrder](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-order.md): Python SDK reference for getOrder.
- [getOrders](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-orders.md): Python SDK reference for getOrders.
- [getPortfolio](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-portfolio.md): Python SDK reference for getPortfolio.
- [getTradeHistory](https://docs.fairground.fi/developers/sdk-reference/python/reference/get-trade-history.md): Python SDK reference for getTradeHistory.
- [liquidate](https://docs.fairground.fi/developers/sdk-reference/python/reference/liquidate.md): Python SDK reference for liquidate.
- [openBulkOrder](https://docs.fairground.fi/developers/sdk-reference/python/reference/open-bulk-order.md): Python SDK reference for openBulkOrder.
- [parse_contract_error](https://docs.fairground.fi/developers/sdk-reference/python/reference/parse-contract-error.md): Python SDK reference for parse_contract_error.
- [pauseMarket](https://docs.fairground.fi/developers/sdk-reference/python/reference/pause-market.md): Python SDK reference for pauseMarket.
- [PerpetualsClient](https://docs.fairground.fi/developers/sdk-reference/python/reference/perpetuals-client.md): Python SDK reference for PerpetualsClient.
- [PerpetualsClientSync](https://docs.fairground.fi/developers/sdk-reference/python/reference/perpetuals-client-sync.md): Python SDK reference for PerpetualsClientSync.
- [removeMarket](https://docs.fairground.fi/developers/sdk-reference/python/reference/remove-market.md): Python SDK reference for removeMarket.
- [retrieveHistoricalPrices](https://docs.fairground.fi/developers/sdk-reference/python/reference/retrieve-historical-prices.md): Python SDK reference for retrieveHistoricalPrices.
- [retrieveOrder](https://docs.fairground.fi/developers/sdk-reference/python/reference/retrieve-order.md): Python SDK reference for retrieveOrder.
- [retrieveOrders](https://docs.fairground.fi/developers/sdk-reference/python/reference/retrieve-orders.md): Python SDK reference for retrieveOrders.
- [streamAllMarketSummaries](https://docs.fairground.fi/developers/sdk-reference/python/reference/stream-all-market-summaries.md): Python SDK reference for streamAllMarketSummaries.
- [streamMarketSummary](https://docs.fairground.fi/developers/sdk-reference/python/reference/stream-market-summary.md): Python SDK reference for streamMarketSummary.
- [updateFees](https://docs.fairground.fi/developers/sdk-reference/python/reference/update-fees.md): Python SDK reference for updateFees.
- [updateMarket](https://docs.fairground.fi/developers/sdk-reference/python/reference/update-market.md): Python SDK reference for updateMarket.
- [updateOpenOrder](https://docs.fairground.fi/developers/sdk-reference/python/reference/update-open-order.md): Python SDK reference for updateOpenOrder.
- [updatePositionLeverage](https://docs.fairground.fi/developers/sdk-reference/python/reference/update-position-leverage.md): Python SDK reference for updatePositionLeverage.
- [updatePositionMargin](https://docs.fairground.fi/developers/sdk-reference/python/reference/update-position-margin.md): Python SDK reference for updatePositionMargin.
- [TypeScript SDK](https://docs.fairground.fi/developers/sdk-reference/typescript/overview.md): TypeScript and JavaScript client for Fairground Perpetuals.
- [Market Makers / LPs](https://docs.fairground.fi/earn/market-makers-lps.md): For liquidity providers and integrators: how fees and rebates relate to matching, plus API and Python SDK entry points.
- [XP Program](https://docs.fairground.fi/earn/xp-program.md)
- [FAQs](https://docs.fairground.fi/faqs.md): Common questions about Fairground perpetual trading and Season 0
- [Protocol Overview](https://docs.fairground.fi/index.md): Fairground perpetuals exchange with fixed fees, no funding rates, and one oracle price.
- [Official Links](https://docs.fairground.fi/official-links.md): Trading app, socials, and other official resources.
- [Trading Hours](https://docs.fairground.fi/trading-hours.md): Market hours for crypto, FX, stocks, and commodities
- [ADL (auto-deleveraging)](https://docs.fairground.fi/trading/advanced/adl.md): What ADL is, when it triggers, and what happens to positions
- [Glossary](https://docs.fairground.fi/trading/advanced/glossary.md): Definition of terms used in the protocol
- [Insurance Fund](https://docs.fairground.fi/trading/advanced/insurance-fund.md): When and how the insurance fund is used
- [Liquidation](https://docs.fairground.fi/trading/advanced/liquidation.md): How liquidation works, when it triggers, and what happens to your margin
- [Order Matching](https://docs.fairground.fi/trading/advanced/order-matching.md): How orders are matched and filled
- [Advanced Trading Overview](https://docs.fairground.fi/trading/advanced/overview.md): Deep dive into order matching, liquidations, the insurance fund, and ADL.
- [Fees and Rebates](https://docs.fairground.fi/trading/fees-rebates.md): Fee mechanics, rebate allocation, and practical implications for traders.
- [Onboarding](https://docs.fairground.fi/trading/onboarding.md): Get set up to trade on Fairground
- [Orders](https://docs.fairground.fi/trading/orders.md): How to place and modify positions
- [Pricing](https://docs.fairground.fi/trading/pricing.md): The index price **_is_** the mark price

## OpenAPI Specs

- [openapi](https://docs.fairground.fi/developers/api-reference/openapi.yaml)