# Pipsocket

> Hosted MT5 accounts behind an API. Each call is for one account, at https://api.pipsocket.com/v1/accounts/{account}/..., with the workspace's API key as `Authorization: Bearer <key>`. One trade call is one MT5 trade request, sent once. Each account's stream is a WebSocket at wss://wss.pipsocket.com/v1/accounts/{account}/stream.

The whole documentation in one file: https://docs.pipsocket.com/llms-full.txt. The OpenAPI document: https://docs.pipsocket.com/openapi.json.

## Get started

- [Introduction](https://docs.pipsocket.com/md/index.md): Hosted MT5 accounts behind an API.
- [Quickstart](https://docs.pipsocket.com/md/quickstart.md): From your workspace's key to an order placed and closed.
- [Authentication](https://docs.pipsocket.com/md/authentication.md): Your workspace's API key, and rolling it.
- [Accounts and ids](https://docs.pipsocket.com/md/accounts.md): Account ids, MT5 tickets, request ids, and the times the API uses.

## Orders

- [Place an order](https://docs.pipsocket.com/md/api/place-an-order.md): A market or pending order, sent once.
- [Check an order](https://docs.pipsocket.com/md/api/check-an-order.md): MT5's dry run: whether it would pass, and its margin.
- [Look up a request](https://docs.pipsocket.com/md/api/look-up-a-request.md): A trade request and MT5's answer.
- [Modify an order](https://docs.pipsocket.com/md/api/modify-an-order.md): A pending order's price, stops and expiry.
- [Cancel an order](https://docs.pipsocket.com/md/api/cancel-an-order.md): Delete a pending order.
- [Close a position](https://docs.pipsocket.com/md/api/close-a-position.md): Close all or part of an open position.
- [Close by](https://docs.pipsocket.com/md/api/close-by.md): Close a position against an opposite one.
- [Set stops](https://docs.pipsocket.com/md/api/set-stops.md): A position's stop loss and take profit.

## Account data

- [Account](https://docs.pipsocket.com/md/api/account.md): Login, status, balance, equity and margin.
- [Positions](https://docs.pipsocket.com/md/api/positions.md): Open positions, read fresh from the terminal.
- [Pending orders](https://docs.pipsocket.com/md/api/pending-orders.md): Pending orders, read fresh from the terminal.
- [Deal and order history](https://docs.pipsocket.com/md/api/history.md): Deals and past orders in a time range.
- [Symbols and prices](https://docs.pipsocket.com/md/api/symbols.md): The broker's symbols, their specifications and prices.

## Control

- [Kill switch](https://docs.pipsocket.com/md/api/kill-switch.md): Block new exposure and flatten the account.

## Streaming

- [The WebSocket stream](https://docs.pipsocket.com/md/websocket.md): Fills, deals, prices and the account as they happen, and calls over the same socket.

## Reference

- [Errors and retcodes](https://docs.pipsocket.com/md/errors.md): The API's refusals, MT5's retcodes, and what to do about each.
- [MT5 field map](https://docs.pipsocket.com/md/mt5-field-map.md): Which MT5 field each API field is, and what each call fills in itself.
- [Rate limits](https://docs.pipsocket.com/md/rate-limits.md): The limits Pipsocket enforces, and the broker's own.