Documentation

Examples

Real command examples with live response captures.

Copy this to your agent Help first
python -m pip install cornerstones-client
cornerstones-client --help
cornerstones-client guide
Examples Customer guide

At a glance

Every workflow follows Ask / Command / Live response / Access. The JSON blocks below were captured from live Cornerstones API responses on 2026-05-07T13:21Z. Empty arrays, timestamps, artifact paths, and source labels are runtime values from that capture.

FX bars

Ask

"Give my agent the last few hourly XAUUSD bars before it comments on gold."

Command

CommandCopyable
cornerstones-client fx bars --symbol XAUUSD --timeframe 1h --count 3

Live response

Captured from a live Cornerstones API response on 2026-05-07T13:21Z. The capture key is not shown. Source details are normalized to Cornerstones labels.

JSON responseShow full responseHide response
{
  "symbol": "XAUUSD",
  "timeframe": "1h",
  "bars": [
    {
      "symbol": "XAUUSD",
      "timeframe": "1h",
      "open": 4735.71,
      "high": 4743.52,
      "low": 4727.03,
      "close": 4742.6,
      "volume": 9048,
      "timestamp": "2026-05-07T15:00:00+01:00",
      "provenance": "cornerstones_market_data",
      "degraded": false
    },
    {
      "symbol": "XAUUSD",
      "timeframe": "1h",
      "open": 4742.55,
      "high": 4752.49,
      "low": 4733.04,
      "close": 4749.47,
      "volume": 12620,
      "timestamp": "2026-05-07T16:00:00+01:00",
      "provenance": "cornerstones_market_data",
      "degraded": false
    },
    {
      "symbol": "XAUUSD",
      "timeframe": "1h",
      "open": 4749.47,
      "high": 4750.13,
      "low": 4730.95,
      "close": 4741.72,
      "volume": 5748,
      "timestamp": "2026-05-07T17:00:00+01:00",
      "provenance": "cornerstones_market_data",
      "degraded": false
    }
  ],
  "count": 3,
  "provenance": "cornerstones_market_data",
  "degraded": false,
  "message": "Cornerstones realtime candlesticks"
}

Access

Available with basic authenticated market access.

Gold context packet

Ask

"Give my agent a 1h XAUUSD context packet."

Command

CommandCopyable
cornerstones-client context gold --symbol XAUUSD --timeframe 1h --count 3

Live response

Captured from a live Cornerstones API response on 2026-05-07T13:21Z. The capture key is not shown. Source details are normalized to Cornerstones labels.

JSON responseCopyable
{
  "context": {
    "xauusd_spot": 4742.41,
    "xauusd_timestamp": "2026-05-07T16:21:52+01:00",
    "gc_futures_front": 4746.1,
    "gc_futures_month": "2026-04",
    "gld_price": 430.96,
    "gdx_price": 92.44,
    "sentiment_score": 0.098,
    "narrative_summary": "Gold showing neutral sentiment (score: 0.10). XAUUSD spot at $4742.41. Technical levels: support $4695, resistance $4790.",
    "provenance": "cornerstones_gold_context",
    "degraded": false,
    "timestamp": "2026-05-07T13:21:50.219441Z"
  },
  "provenance": "cornerstones_gold_context",
  "degraded": false,
  "message": "Cornerstones gold context"
}

Access

Requires Pro or Max context access.

A-share quote

Ask

"Check a China A-share symbol without confusing it with a US ticker."

Command

CommandCopyable
cornerstones-client stocks quote --symbol 600519.SS

Live response

Captured from a live Cornerstones API response on 2026-05-07T13:21Z. The capture key is not shown. Source details are normalized to Cornerstones labels.

JSON responseCopyable
{
  "quote": {
    "symbol": "600519.SS",
    "bid": 1370.912895,
    "ask": 1371.187105,
    "mid": 1371.05,
    "timestamp": "2026-05-07T13:21:51.150227Z",
    "freshness_ms": 0,
    "freshness_status": null,
    "market_state": null,
    "provenance": "cornerstones_equities",
    "degraded": false
  },
  "provenance": "cornerstones_equities",
  "degraded": false,
  "message": "Cornerstones realtime quote"
}

Access

Available with basic authenticated market access, usage permitting.

Chart artifact

Ask

"Render a 15m gold chart with trend and momentum overlays that a multimodal agent can inspect."

Command

CommandCopyable
cornerstones-client chart fx --symbol XAUUSD --timeframe 15m --bars 200 --indicator ema20 --indicator rsi14

Live response

Captured from a live Cornerstones API response on 2026-05-07T13:21Z. The capture key is not shown. Source details are normalized to Cornerstones labels.

JSON responseShow full responseHide response
{
  "symbol": "XAUUSD",
  "timeframe": "15m",
  "bars_count": 200,
  "engine": "cornerstones_chart_renderer",
  "image_path": "/tmp/cornerstones/charts/fx_XAUUSD_15m_200_1778160111859.png",
  "html_path": "/tmp/cornerstones/charts/fx_XAUUSD_15m_200_1778160111859.html",
  "manifest_path": "/tmp/cornerstones/charts/fx_XAUUSD_15m_200_1778160111859.manifest.json",
  "image_url": "/v1/charting/artifacts/fx_XAUUSD_15m_200_1778160111859.png",
  "html_url": "/v1/charting/artifacts/fx_XAUUSD_15m_200_1778160111859.html",
  "manifest_url": "/v1/charting/artifacts/fx_XAUUSD_15m_200_1778160111859.manifest.json",
  "image_width": 1600,
  "image_height": 1000,
  "indicators": [
    "rsi"
  ],
  "requested_indicators": [
    "rsi14"
  ],
  "provenance": "cornerstones_chart_local",
  "degraded": false,
  "fallback": null,
  "message": "Cornerstones chart rendered",
  "symbol_requested": "XAUUSD",
  "symbol_resolved": "XAUUSD",
  "market": "fx",
  "bars_policy": "explicit",
  "template": "legacy_default",
  "layout": "single",
  "chart_type": "candlestick",
  "artifacts": {
    "image_path": "/tmp/cornerstones/charts/fx_XAUUSD_15m_200_1778160111859.png",
    "html_path": "/tmp/cornerstones/charts/fx_XAUUSD_15m_200_1778160111859.html",
    "manifest_path": "/tmp/cornerstones/charts/fx_XAUUSD_15m_200_1778160111859.manifest.json",
    "image_url": "/v1/charting/artifacts/fx_XAUUSD_15m_200_1778160111859.png",
    "html_url": "/v1/charting/artifacts/fx_XAUUSD_15m_200_1778160111859.html",
    "manifest_url": "/v1/charting/artifacts/fx_XAUUSD_15m_200_1778160111859.manifest.json"
  },
  "applied_indicators": [
    "rsi"
  ],
  "layers": [],
  "requested_layers": [],
  "applied_layers": [],
  "include": [
    "quote",
    "indicators",
    "session"
  ],
  "manifest": {
    "render_spec": {
      "market": "fx",
      "symbol_requested": "XAUUSD",
      "symbol_resolved": "XAUUSD",
      "exchange_resolved": "FX",
      "timeframe": "15m",
      "bars_policy": "explicit",
      "bars_target": 200,
      "template": "legacy_default",
      "layout": "single",
      "chart_type": "candlestick",
      "layers_requested": [],
      "layers_applied": [],
      "requested_indicators": [
        "rsi14"
      ],
      "applied_indicators": [
        "rsi"
      ],
      "grid_config": null,
      "context_symbols": []
    },
    "visible_window": {
      "visible_range_from": "2026-05-05T13:30:00+01:00",
      "visible_range_to": "2026-05-07T17:15:00+01:00",
      "visible_bars_actual": 200,
      "last_visible_bar_timestamp": "2026-05-07T17:15:00+01:00",
      "reason": null
    },
    "price_edge": {
      "last_visible_bar": {
        "open": 4732.89,
        "high": 4742.32,
        "low": 4731.22,
        "close": 4742.32,
        "timestamp": "2026-05-07T17:15:00+01:00"
      },
      "live_quote": {
        "last": 4742.639999999999,
        "bid": 4742.32,
        "ask": 4742.96,
        "mid": 4742.639999999999,
        "timestamp": "2026-05-07T16:21:54+01:00",
        "freshness_ms": -7202126,
        "provenance": "cornerstones_market_data",
        "degraded": false
      },
      "right_axis_anchor_price": 4742.639999999999,
      "anchor_price_type": "live_quote",
      "delta_live_vs_last_bar_close": 0.32,
      "delta_live_vs_last_bar_close_pct": 0.00674775
    },
    "companion": {
      "price_summary": {
        "requested": null,
        "available": null,
        "degraded": null,
        "reason": null,
        "message": null,
        "provenance": null,
        "semantic_class": "deterministic_derived",
        "producer_type": "charting_service",
        "source_class": "fact_derived",
        "availability": {
          "requested": true,
          "available": true,
          "degraded": false,
          "reason": null,
          "message": null
        },
        "source_ref": {
          "component": null,
          "provenance": null,
          "quote_provenance": "cornerstones_market_data",
          "bars_provenance": "cornerstones_market_data"
        },
        "gating_state": null,
        "generated_by_cornerstones": true,
        "is_cornerstones_house_view": true,
        "consumer_guidance": "Use as deterministic derived companion summary, not raw market truth.",
        "usage_note": "Derived from the live quote and the last visible bar.",
        "last_price": 4742.639999999999,
        "bid": 4742.32,
        "ask": 4742.96,
        "mid": 4742.639999999999,
        "last_bar_close": 4742.32,
        "anchor_price": 4742.639999999999,
        "anchor_price_type": "live_quote",
        "quote_provenance": "cornerstones_market_data",
        "bars_provenance": "cornerstones_market_data"
      },
      "indicator_snapshot": {
        "requested": null,
        "available": null,
        "degraded": false,
        "reason": null,
        "message": null,
        "provenance": "cornerstones_market_data",
        "semantic_class": "deterministic_derived",
        "producer_type": "charting_service",
        "source_class": "fact_derived",
        "availability": {
          "requested": true,
          "available": true,
          "degraded": false,
          "reason": null,
          "message": null
        },
        "source_ref": {
          "component": "indicators",
          "provenance": "cornerstones_market_data"
        },
        "gating_state": null,
        "generated_by_cornerstones": true,
        "is_cornerstones_house_view": true,
        "consumer_guidance": "Use as deterministic derived companion summary, not raw market truth.",
        "usage_note": "Structured companion export from stocks indicators.",
        "price_summary": {
          "last": 4742.32,
          "high_20": 4752.49,
          "low_20": 4721.42
        },
        "indicators": {
          "ema_20": 4737.020656856778,
          "ema_50": 4725.080373807326,
          "rsi_14": 55.131658621575625,
          "adx": 14.442520816230475,
          "macd_12_26_9": {
            "line": 5.105477639183846,
            "signal": 5.68803166273981,
            "histogram": -0.5825540235559643
          },
          "atr_14": 10.287393714373612,
          "vwap": 4675.184097860914,
          "bollinger_20_2": {
            "upper": 4748.861715661268,
            "middle": 4737.052000000001,
            "lower": 4725.242284338733
          },
          "returns_1d": 0.012664931315542693,
          "returns_5d": 0.02616289763125268
        }
      },
      "session_summary": {
        "requested": null,
        "available": null,
        "degraded": false,
        "reason": null,
        "message": null,
        "provenance": "cornerstones_market_data",
        "semantic_class": "deterministic_derived",
        "producer_type": "charting_service",
        "source_class": "fact_derived",
        "availability": {
          "requested": true,
          "available": true,
          "degraded": false,
          "reason": null,
          "message": null
        },
        "source_ref": {
          "component": "session",
          "provenance": "cornerstones_market_data"
        },
        "gating_state": null,
        "generated_by_cornerstones": true,
        "is_cornerstones_house_view": true,
        "consumer_guidance": "Use as deterministic derived companion summary, not raw market truth.",
        "usage_note": "Structured companion export from stocks session data.",
        "session_name": "overlap",
        "market_session": "overlap",
        "is_session_open": true,
        "session_window": {
          "start": "13:00Z",
          "end": "16:00Z",
          "timezone": "UTC"
        },
        "session_open": null,
        "session_high": 4736.05,
        "session_low": 4726.31,
        "distance_to_session_high": 6.289999999999964,
        "distance_to_session_low": 16.029999999999745,
        "previous_day_high": null,
        "previous_day_low": null,
        "previous_close": null
      },
      "context_summary": {
        "requested": null,
        "available": null,
        "degraded": null,
        "reason": null,
        "message": null,
        "provenance": null,
        "semantic_class": null,
        "producer_type": null,
        "source_class": null,
        "availability": null,
        "source_ref": null,
        "gating_state": null,
        "generated_by_cornerstones": null,
        "is_cornerstones_house_view": null,
        "consumer_guidance": null,
        "usage_note": null
      },
      "cross_asset_summary": {
        "requested": null,
        "available": null,
        "degraded": null,
        "reason": null,
        "message": null,
        "provenance": null,
        "semantic_class": null,
        "producer_type": null,
        "source_class": null,
        "availability": null,
        "source_ref": null,
        "gating_state": null,
        "generated_by_cornerstones": null,
        "is_cornerstones_house_view": null,
        "consumer_guidance": null,
        "usage_note": null
      },
      "multi_timeframe_bars": {
        "requested": null,
        "available": null,
        "degraded": null,
        "reason": null,
        "message": null,
        "provenance": null,
        "semantic_class": null,
        "producer_type": null,
        "source_class": null,
        "availability": null,
        "source_ref": null,
        "gating_state": null,
        "generated_by_cornerstones": null,
        "is_cornerstones_house_view": null,
        "consumer_guidance": null,
        "usage_note": null
      },
      "advanced_summary": {
        "requested": null,
        "available": null,
        "degraded": null,
        "reason": null,
        "message": null,
        "provenance": null,
        "semantic_class": null,
        "producer_type": null,
        "source_class": null,
        "availability": null,
        "source_ref": null,
        "gating_state": null,
        "generated_by_cornerstones": null,
        "is_cornerstones_house_view": null,
        "consumer_guidance": null,
        "usage_note": null
      }
    },
    "capabilities": {
      "supports_session_overlay": false,
      "supports_session_profile": false,
      "supports_cvd": false,
      "supports_vwap": false,
      "supports_benchmarks": false
    },
    "governance": {
      "experimental": false,
      "degraded": false,
      "fallback": null,
      "usage_hint": "analysis_and_agent_reading",
      "manifest_semantics_version": "chart_manifest_v2",
      "component_status": {
        "price_summary": {
          "requested": true,
          "available": true,
          "degraded": false,
          "reason": null,
          "message": null,
          "provenance": null,
          "semantic_class": "deterministic_derived",
          "producer_type": "charting_service",
          "source_class": "fact_derived",
          "availability": null,
          "source_ref": {
            "component": null,
            "provenance": null,
            "quote_provenance": "cornerstones_market_data",
            "bars_provenance": "cornerstones_market_data"
          },
          "gating_state": null,
          "generated_by_cornerstones": null,
          "is_cornerstones_house_view": null,
          "consumer_guidance": null,
          "usage_note": null
        },
        "indicator_snapshot": {
          "requested": true,
          "available": true,
          "degraded": false,
          "reason": null,
          "message": null,
          "provenance": null,
          "semantic_class": "deterministic_derived",
          "producer_type": "charting_service",
          "source_class": "fact_derived",
          "availability": null,
          "source_ref": {
            "component": "indicators",
            "provenance": "cornerstones_market_data"
          },
          "gating_state": null,
          "generated_by_cornerstones": null,
          "is_cornerstones_house_view": null,
          "consumer_guidance": null,
          "usage_note": null
        },
        "session_summary": {
          "requested": true,
          "available": true,
          "degraded": false,
          "reason": null,
          "message": null,
          "provenance": null,
          "semantic_class": "deterministic_derived",
          "producer_type": "charting_service",
          "source_class": "fact_derived",
          "availability": null,
          "source_ref": {
            "component": "session",
            "provenance": "cornerstones_market_data"
          },
          "gating_state": null,
          "generated_by_cornerstones": null,
          "is_cornerstones_house_view": null,
          "consumer_guidance": null,
          "usage_note": null
        },
        "context_summary": {
          "requested": false,
          "available": false,
          "degraded": false,
          "reason": null,
          "message": null,
          "provenance": null,
          "semantic_class": null,
          "producer_type": null,
          "source_class": null,
          "availability": null,
          "source_ref": null,
          "gating_state": null,
          "generated_by_cornerstones": null,
          "is_cornerstones_house_view": null,
          "consumer_guidance": null,
          "usage_note": null
        },
        "cross_asset_summary": {
          "requested": false,
          "available": false,
          "degraded": false,
          "reason": null,
          "message": null,
          "provenance": null,
          "semantic_class": null,
          "producer_type": null,
          "source_class": null,
          "availability": null,
          "source_ref": null,
          "gating_state": null,
          "generated_by_cornerstones": null,
          "is_cornerstones_house_view": null,
          "consumer_guidance": null,
          "usage_note": null
        },
        "multi_timeframe_bars": {
          "requested": false,
          "available": false,
          "degraded": false,
          "reason": null,
          "message": null,
          "provenance": null,
          "semantic_class": null,
          "producer_type": null,
          "source_class": null,
          "availability": null,
          "source_ref": null,
          "gating_state": null,
          "generated_by_cornerstones": null,
          "is_cornerstones_house_view": null,
          "consumer_guidance": null,
          "usage_note": null
        },
        "advanced_summary": {
          "requested": false,
          "available": false,
          "degraded": false,
          "reason": null,
          "message": null,
          "provenance": null,
          "semantic_class": null,
          "producer_type": null,
          "source_class": null,
          "availability": null,
          "source_ref": null,
          "gating_state": null,
          "generated_by_cornerstones": null,
          "is_cornerstones_house_view": null,
          "consumer_guidance": null,
          "usage_note": null
        }
      },
      "notes": []
    }
  },
  "capabilities": {
    "supports_session_overlay": false,
    "supports_session_profile": false,
    "supports_cvd": false,
    "supports_vwap": false,
    "supports_benchmarks": false
  },
  "experimental": false
}

Access

Requires Pro or Max context access.

Order-flow summary

Ask

"Show whether gold has visible pressure or liquidity imbalance before the agent writes a trade note."

Command

CommandCopyable
cornerstones-client orderflow summary --symbol XAUUSD

Live response

Captured from a live Cornerstones API response on 2026-05-07T13:21Z. The capture key is not shown. Source details are normalized to Cornerstones labels.

JSON responseShow full responseHide response
{
  "data": {
    "symbol": "XAUUSD",
    "futures_symbol": "GC",
    "exchange": "COMEX",
    "mode": "live",
    "summary": {
      "book_pressure_direction": "sell",
      "book_pressure_strength": "strong",
      "trade_aggression_bias": "buyer_aggressive",
      "microstructure_state": "exhaustion",
      "session_liquidity_regime": "thin",
      "delta_persistence": "persistent_buying",
      "imbalance_persistence": "persistent_offer",
      "reaction_quality": "fragile",
      "absorption_signal": "none",
      "exhaustion_signal": "buyer_exhaustion",
      "follow_through_quality": "absent",
      "aggression_flip": "to_sellers",
      "continuation_quality": "failed"
    },
    "readiness": {
      "support_only": false,
      "confirmation_only": true,
      "directional_candidate_ok": false,
      "production_ready": false
    },
    "timestamps": {
      "provider_time": "2026-05-07T13:22:00.541322Z",
      "snapshot_time": "2026-05-07T13:22:00.541322Z",
      "latency_ms": null
    },
    "provenance": "cornerstones_orderflow",
    "degraded": false,
    "fallback": null,
    "proxy": false,
    "experimental": true,
    "data_quality_status": "ok",
    "freshness_status": "fresh",
    "trust_tier": "confirmed",
    "usage_hint": "confirmation_input",
    "field_maturity": {
      "summary.book_pressure_direction": "candidate",
      "summary.trade_aggression_bias": "candidate",
      "summary.microstructure_state": "experimental",
      "summary.absorption_signal": "experimental",
      "summary.exhaustion_signal": "experimental",
      "summary.follow_through_quality": "experimental",
      "summary.aggression_flip": "experimental",
      "summary.continuation_quality": "experimental",
      "readiness.directional_candidate_ok": "experimental"
    },
    "degraded_confidence_cap": null
  },
  "message": null
}

Access

Max.

Event evidence

Ask

"Give the agent recent market events it can cite, not a vague macro story."

Command

CommandCopyable
cornerstones-client events recent

Live response

Captured from a live Cornerstones API response on 2026-05-07T13:21Z. The capture key is not shown. Source details are normalized to Cornerstones labels.

JSON responseCopyable
{
  "events": [],
  "count": 0,
  "next_cursor": null,
  "has_more": false,
  "provenance": "cornerstones_events_v1",
  "data_quality": {
    "provider_status": "primary",
    "store": "file_backed_json",
    "scope": "recent_or_active_events",
    "lookback_hours": 24
  },
  "degraded": false,
  "fallback": null
}

Access

Free for recent events where available; premium export and deeper workflows require Pro or above.