Utilities¶

The eptr2.util module provides utility functions for common operations.

Time Utilities¶

eptr2.util.time¶

Utility functions for time and date handling.

from eptr2.util.time import iso_to_contract

iso_to_contract¶

Converts ISO datetime to contract symbol format.

from eptr2.util.time import iso_to_contract

contract = iso_to_contract("2024-07-29T10:00:00+03:00")
print(contract)  # e.g., "PH24072910"

Mapping Utilities¶

eptr2.mapping¶

Utilities for API endpoint mapping and discovery.

from eptr2.mapping import (
    get_path_map,
    alias_to_path,
    get_alias_map,
)

get_path_map¶

Returns the complete mapping of API endpoint paths.

from eptr2.mapping import get_path_map

# Get all path keys
paths = get_path_map(just_call_keys=True)
print(len(paths))  # 213+

alias_to_path¶

Converts an alias to its canonical path.

from eptr2.mapping import alias_to_path

path = alias_to_path("ptf")
print(path)  # "mcp"

get_alias_map¶

Returns dictionary of all aliases.

from eptr2.mapping import get_alias_map

aliases = get_alias_map()
# {'ptf': 'mcp', 'smf': 'smp', ...}

eptr2.mapping.help¶

Help and documentation utilities.

from eptr2.mapping.help import get_help_d

get_help_d¶

Get documentation for an API endpoint.

from eptr2.mapping.help import get_help_d

# Get help for specific call
help_info = get_help_d("mcp")
print(help_info['category'])     # "GÖP"
print(help_info['title']['en'])  # "Market Clearing Price"
print(help_info['desc']['en'])   # Description
print(help_info['url'])          # Official docs URL

# Get all help entries
all_help = get_help_d()

Returns:

Key	Type	Description
`category`	`str`	Market category (GÖP, GİP, etc.)
`title`	`dict`	Titles in `tr` and `en`
`desc`	`dict`	Descriptions in `tr` and `en`
`url`	`str`	Link to official documentation

Processing Utilities¶

eptr2.processing.preprocess¶

Preprocessing utilities for API parameters.

from eptr2.processing.preprocess import preprocess_parameter

These utilities are primarily used internally by the EPTR2 class.

Examples¶

Finding API Endpoints¶

from eptr2.mapping import get_path_map, alias_to_path

# List all endpoints
all_endpoints = get_path_map(just_call_keys=True)

# Find price-related endpoints
price_endpoints = [e for e in all_endpoints if 'price' in e.lower()]
print(price_endpoints)

# Check if alias exists
canonical = alias_to_path("ptf")
print(f"'ptf' maps to '{canonical}'")

Getting API Documentation¶

from eptr2.mapping.help import get_help_d

# Get documentation for consumption endpoint
help_info = get_help_d("rt-consumption")

print(f"Category: {help_info['category']}")
print(f"Title (TR): {help_info['title']['tr']}")
print(f"Title (EN): {help_info['title']['en']}")
print(f"Description: {help_info['desc']['en']}")

Working with Contract Symbols¶

from eptr2.util.time import iso_to_contract

# Convert timestamps to contract symbols
timestamps = [
    "2024-07-29T00:00:00+03:00",
    "2024-07-29T12:00:00+03:00",
    "2024-07-29T23:00:00+03:00",
]

for ts in timestamps:
    contract = iso_to_contract(ts)
    print(f"{ts} -> {contract}")