psxdata-docs/docs.json at master · psxdata/psxdata-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
{
  "$schema": "https://mintlify.com/docs.json",
  "name": "psxdata",
  "theme": "maple",
  "colors": {
    "primary": "#0EA5E9",
    "light": "#38BDF8",
    "dark": "#0284C7"
  },
  "fonts": {
    "family": "Inter"
  },
  "appearance": {
    "default": "system",
    "strict": false
  },
  "background": {
    "decoration": "gradient"
  },
  "navbar": {
    "links": [
      { "type": "github", "href": "https://github.com/psxdata/psxdata" }
    ]
  },
  "api": {
    "openapi": "openapi.json",
    "playground": { "display": "interactive" },
    "examples": {
      "languages": ["bash", "python", "javascript"],
      "defaults": "all",
      "autogenerate": true
    }
  },
  "navigation": {
    "global": {
      "anchors": [
        { "anchor": "Changelog", "icon": "list", "href": "/changelog" },
        { "anchor": "Contributing", "icon": "handshake", "href": "/contributing" }
      ]
    },
    "tabs": [
      {
        "tab": "Python SDK",
        "icon": "python",
        "groups": [
          {
            "group": "Overview",
            "pages": ["index", "sdk/getting-started"]
          },
          {
            "group": "Guides",
            "pages": [
              "sdk/guides/free-psx-api",
              "sdk/guides/historical-data",
              "sdk/guides/stock-screener",
              "sdk/guides/sector-analysis",
              "sdk/guides/indices",
              "sdk/guides/realtime-snapshot",
              "sdk/guides/proxy"
            ]
          },
          {
            "group": "API Reference",
            "pages": [
              "sdk/reference/client",
              "sdk/reference/exceptions"
            ]
          }
        ]
      },
      {
        "tab": "REST API",
        "icon": "square-terminal",
        "groups": [
          {
            "group": "Overview",
            "pages": ["rest-api/introduction"]
          },
          {
            "group": "Guides",
            "pages": ["rest-api/guides/quickstart", "rest-api/guides/proxy"]
          },
          {
            "group": "Endpoints",
            "openapi": "openapi.json",
            "pages": [
              "GET /health",
              "GET /stocks",
              "GET /stocks/{symbol}/historical",
              "GET /stocks/{symbol}/quote",
              "GET /stocks/{symbol}/fundamentals",
              "GET /indices",
              "GET /indices/{name}",
              "GET /sectors",
              "GET /sectors/{name}/stocks",
              "GET /screener",
              "GET /debt-market",
              "GET /eligible-scrips"
            ]
          }
        ]
      }
    ]
  }
}