Positions Endpoint

OANDA Reference: Position Endpoints

Position monitoring and management.

---

get_positions

Get a list of all positions (open and closed) for an account.

OANDA Endpoint: GET /v3/accounts/{accountID}/positions

import asyncio
from typing import TYPE_CHECKING

from dotenv import load_dotenv

from fivetwenty import AsyncClient

if TYPE_CHECKING:
    from fivetwenty.endpoints.positions import PositionsResponse

load_dotenv()


async def main() -> None:
    async with AsyncClient() as client:
        # Retrieve all positions (open and closed) for the account
        result: PositionsResponse = await client.positions.get_positions(
            account_id=client.account_id
        )
        positions = result["positions"]
        print(f"Found {len(positions)} position(s)")
        print(f"Last Transaction ID: {result['lastTransactionID']}")


asyncio.run(main())

🔗 OANDA Documentation: Get Positions

🔗 Source: positions.get_positions

Parameters:

Parameter	Type	Required	Description
account_id	AccountID	✅	Account identifier

Returns: Dictionary containing list of positions (list[Position]) and last transaction ID (str)

Raises:

FiveTwentyError - API errors:

• 401/403: Authentication failed (check e.is_authentication_error)
• 404: Account not found (check e.is_not_found)
• 429: Rate limit exceeded (check e.is_rate_limited)

---

get_open_positions

Get a list of all open positions for an account.

OANDA Endpoint: GET /v3/accounts/{accountID}/openPositions

import asyncio
from typing import TYPE_CHECKING

from dotenv import load_dotenv

from fivetwenty import AsyncClient

if TYPE_CHECKING:
    from fivetwenty.endpoints.positions import PositionsResponse

load_dotenv()


async def main() -> None:
    async with AsyncClient() as client:
        # Retrieve only open positions for the account
        result: PositionsResponse = await client.positions.get_open_positions(
            account_id=client.account_id
        )
        open_positions = result["positions"]
        print(f"Found {len(open_positions)} open position(s)")
        print(f"Last Transaction ID: {result['lastTransactionID']}")


asyncio.run(main())

🔗 OANDA Documentation: Get Open Positions

🔗 Source: positions.get_open_positions

Parameters:

Parameter	Type	Required	Description
account_id	AccountID	✅	Account identifier

Returns: Dictionary containing list of open positions (list[Position]) and last transaction ID (str)

Raises:

FiveTwentyError - API errors:

• 401/403: Authentication failed (check e.is_authentication_error)
• 404: Account not found (check e.is_not_found)
• 429: Rate limit exceeded (check e.is_rate_limited)

---

get_position

Get the position for a specific instrument in an account.

OANDA Endpoint: GET /v3/accounts/{accountID}/positions/{instrument}

import asyncio
from typing import TYPE_CHECKING

from dotenv import load_dotenv

from fivetwenty import AsyncClient
from fivetwenty.models import InstrumentName

if TYPE_CHECKING:
    from fivetwenty.endpoints.positions import PositionResponse

load_dotenv()


async def main() -> None:
    async with AsyncClient() as client:
        # Get position details for a specific instrument
        result: PositionResponse = await client.positions.get_position(
            account_id=client.account_id,
            instrument=InstrumentName.EUR_USD,  # Change to your instrument
        )
        position = result["position"]
        print(f"Instrument: {position.instrument}")
        print(f"Last Transaction ID: {result['lastTransactionID']}")


asyncio.run(main())

🔗 OANDA Documentation: Get Position

🔗 Source: positions.get_position

Parameters:

Parameter	Type	Required	Description
account_id	AccountID	✅	Account identifier
instrument	InstrumentName	✅	Name of the instrument

Returns: Dictionary containing position details (Position) and last transaction ID (str)

Raises:

FiveTwentyError - API errors:

• 401/403: Authentication failed (check e.is_authentication_error)
• 404: Position not found (check e.is_not_found)
• 429: Rate limit exceeded (check e.is_rate_limited)

---

close_position

Close the open position for a specific instrument.

OANDA Endpoint: PUT /v3/accounts/{accountID}/positions/{instrument}/close

import asyncio
from typing import TYPE_CHECKING

from dotenv import load_dotenv

from fivetwenty import AsyncClient
from fivetwenty.models import InstrumentName

if TYPE_CHECKING:
    from fivetwenty.endpoints.positions import ClosePositionResponse

load_dotenv()


async def main() -> None:
    async with AsyncClient() as client:
        # Close all long units for a specific instrument
        result: ClosePositionResponse = await client.positions.close_position(
            account_id=client.account_id,
            instrument=InstrumentName.EUR_USD,  # Change to your instrument
            long_units="ALL",  # Use "ALL" to close entire position, or specify units
        )
        print(f"Last Transaction ID: {result['lastTransactionID']}")
        if "longOrderFillTransaction" in result:
            print(f"Long position closed: {result['longOrderFillTransaction']}")


asyncio.run(main())

🔗 OANDA Documentation: Close Position

🔗 Source: positions.close_position

Parameters:

Parameter	Type	Required	Description
account_id	AccountID	✅	Account identifier
instrument	InstrumentName	✅	Name of the instrument
*			Keyword-only parameters below
long_units	str | Decimal | None	➖	Units of long position to close ("ALL", "NONE", or number)
short_units	str | Decimal | None	➖	Units of short position to close ("ALL", "NONE", or number)
long_client_extensions	ClientExtensions | None	➖	Client extensions for long position closure order
short_client_extensions	ClientExtensions | None	➖	Client extensions for short position closure order

Returns: Dictionary containing closure transaction details and last transaction ID (str)

Raises:

FiveTwentyError - API errors:

• 400: Invalid request parameters (check e.is_bad_request)
• 401/403: Authentication failed (check e.is_authentication_error)
• 404: Position not found or already closed (check e.is_not_found)
• 429: Rate limit exceeded (check e.is_rate_limited)