Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 19, 2025

This PR adds comprehensive documentation for all supported assets and timeframes in the PocketOption API, addressing the community request for clarity on what trading instruments are available.

What's Added

New Documentation Page

  • Created /docs/assets-timeframes.html with complete listings of all supported trading instruments
  • Professional styling that matches the existing documentation design
  • Organized content by asset categories for easy navigation

Comprehensive Asset Coverage (121 total assets)

  • Major Forex Pairs (7): EURUSD, GBPUSD, USDJPY, etc.
  • OTC Forex Pairs (25): Extended trading hours currency pairs
  • Commodities (14): Gold, Silver, Oil, Natural Gas, Platinum, Palladium
  • Cryptocurrencies (10): Bitcoin, Ethereum, Dash, Polkadot, Chainlink
  • Stock Indices (24): S&P 500, NASDAQ, Dow Jones, Nikkei 225, DAX 30, etc.
  • US Stocks (36): Apple, Microsoft, Tesla, Amazon, Netflix, etc.
  • Additional Assets (5): Alternative stock symbol formats

Complete Timeframe Documentation (14 timeframes)

  • From ultra-high frequency (1 second) to long-term (1 month)
  • Both TimeFrame enum values and raw seconds provided
  • Clear use case descriptions for each timeframe (scalping, swing trading, etc.)

Enhanced User Experience

  • Navigation menu updated across all documentation pages
  • Practical usage examples with code samples
  • Important notes about asset availability and trading hours
  • Copy-to-clipboard functionality for code examples
  • Responsive grid layout for easy browsing

Code Examples

The documentation includes practical examples showing how to use the asset symbols:

# Getting candles for different asset types
forex_candles = await client.get_candles("GBPUSD_otc", TimeFrame.H1, 24)
crypto_candles = await client.get_candles("BTCUSD", TimeFrame.M15, 96)
stock_candles = await client.get_candles("#AAPL", TimeFrame.D1, 30)

This documentation eliminates confusion about which assets are supported and provides developers with the exact symbols needed for API calls.

Fixes #38.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI self-assigned this Aug 19, 2025
Copy link
Contributor Author

Copilot AI commented Aug 19, 2025

@theshadow76 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Co-authored-by: theshadow76 <59869868+theshadow76@users.noreply.github.com>
Copilot AI changed the title [WIP] Supported Assets and timeframes Add comprehensive documentation for supported assets and timeframes Aug 19, 2025
Copilot AI requested a review from theshadow76 August 19, 2025 21:28
@theshadow76 theshadow76 marked this pull request as ready for review November 29, 2025 12:21
Copilot AI review requested due to automatic review settings November 29, 2025 12:21
@theshadow76 theshadow76 merged commit 8fa1775 into main Nov 29, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 29, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a comprehensive documentation page listing all 121 supported trading assets and 14 timeframes available in the PocketOption API. The documentation is well-organized into categories (Major Forex, OTC Forex, Commodities, Cryptocurrencies, Stock Indices, and US Stocks) and provides practical code examples for using these assets. The page integrates seamlessly with the existing documentation by adding navigation links across all HTML files and following the established purple-themed design.

Key Changes:

  • Created new assets-timeframes.html with detailed asset listings and timeframe reference
  • Added navigation link to "Assets & Timeframes" in all existing documentation pages
  • Included practical usage examples demonstrating how to use asset symbols with the API

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/assets-timeframes.html New comprehensive documentation page with all supported assets, timeframes, usage examples, and styling
docs/index.html Added navigation link to new assets-timeframes page
docs/quickstart.html Added navigation link to new assets-timeframes page
docs/api.html Added navigation link to new assets-timeframes page
docs/examples.html Added navigation link to new assets-timeframes page
docs/faq.html Added navigation link to new assets-timeframes page

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

<a href="quickstart.html">Quickstart</a>
<a href="api.html">API Reference</a>
<a href="examples.html">Examples</a>
<a href="assets-timeframes.html" class="active">Assets & Timeframes</a>
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "active" class is applied to the current navigation link but there is no corresponding CSS style defined in style.css. This class has no visual effect. Either add a CSS rule for .active class in style.css (e.g., to highlight the current page in navigation) or remove the class attribute if not needed.

Copilot uses AI. Check for mistakes.

# Getting data for different asset types
forex_candles = await client.get_candles("GBPUSD_otc", TimeFrame.H1, 24)
crypto_candles = await client.get_candles("ETHUSD", TimeFrame.M15, 96)
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The code example uses "ETHUSD" but earlier in line 355 uses "GBPUSD_otc". For consistency with the practical examples showing different asset types, consider using "BTCUSD" (as used in line 352) or another crypto asset that's distinct from the one in line 352 to demonstrate variety. However, ETHUSD is valid and this is only a minor consistency suggestion.

Suggested change
crypto_candles = await client.get_candles("ETHUSD", TimeFrame.M15, 96)
crypto_candles = await client.get_candles("LTCUSD", TimeFrame.M15, 96)

Copilot uses AI. Check for mistakes.
Comment on lines +333 to +335
<div class="asset-item">Facebook_OTC <em>(Facebook Alternative)</em></div>
<div class="asset-item">Tesla_otc <em>(Tesla Alternative)</em></div>
<div class="asset-item">Boeing_OTC <em>(Boeing Alternative)</em></div>
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent capitalization in OTC suffix: "Facebook_OTC" and "Boeing_OTC" use uppercase "OTC" while "Tesla_otc" uses lowercase "otc". According to the source code constants.py, the correct symbols are "Facebook_OTC" (line 135), "Tesla_otc" (line 136), and "Boeing_OTC" (line 137). The documentation correctly reflects the source code, but this inconsistency in the actual asset naming could confuse users. Consider adding a note in the "Important Notes" section about exact case sensitivity for these specific alternative format symbols.

Copilot uses AI. Check for mistakes.
Comment on lines +10 to +12
.asset-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The grid layout uses minmax(200px, 1fr) which may cause horizontal scrolling on very small mobile screens (< 200px wide). Consider using a smaller minimum width (e.g., 150px or 180px) or adding a media query to adjust the grid for very small screens to improve mobile accessibility.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supported Assets and timeframes

2 participants