API Documentation

What is SlipYard API

The SlipYard API gives algorithmic traders and developers programmatic access to real-time slippage intelligence. Before you execute — know your cost.

Requires the Dev / API plan ($99/month). Subscribe →

Authentication

Your API key is available from the API Keys page in your dashboard after subscribing to a Dev / API plan.

Send your key in the X-API-Key header on every request. Requests without a valid key receive 401 Unauthorized.

Base URL:  https://api.slipyard.io
Header:    X-API-Key: YOUR_API_KEY

Endpoints

POST /api/v1/should-i-trade

Should I execute this trade right now? Returns a signal, score, and estimated slippage cost.

Request body

{
  "ticker": "AAPL",
  "direction": "buy",
  "size_dollars": 10000
}

Response

{
  "signal": "EXECUTE",
  "score": 82,
  "spread_bps": 1.2,
  "estimated_slippage_bps": 0.8,
  "estimated_slippage_dollars": 0.80,
  "warnings": [],
  "reason": "Tight spread, normal volume, favorable conditions"
}

curl example

curl -X POST https://api.slipyard.io/api/v1/should-i-trade \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticker": "AAPL", "direction": "buy", "size_dollars": 10000}'

GET /api/v1/score/{ticker}

Get the current execution score for a ticker.

Response

{
  "ticker": "AAPL",
  "score": 74,
  "signal": "EXECUTE",
  "spread_bps": 1.1,
  "condition_key": "tight_spread_normal_vol"
}

curl example

curl https://api.slipyard.io/api/v1/score/AAPL \
  -H "X-API-Key: YOUR_API_KEY"

GET /api/v1/batch?tickers=AAPL,MSFT,NVDA

Get scores for multiple tickers at once. Up to 50 tickers per request.

Response

{
  "results": [
    {"ticker": "AAPL", "score": 74, "signal": "EXECUTE"},
    {"ticker": "MSFT", "score": 55, "signal": "CAUTION"},
    {"ticker": "NVDA", "score": 31, "signal": "WAIT"}
  ]
}

curl example

curl "https://api.slipyard.io/api/v1/batch?tickers=AAPL,MSFT,NVDA" \
  -H "X-API-Key: YOUR_API_KEY"

GET /api/v1/score/v2/{ticker}

Enhanced score with regime detection and toxicity analysis.

Response

{
  "ticker": "TSLA",
  "execution_score_v2": 63,
  "regime": "high_volatility",
  "toxicity_score": 0.42,
  "adverse_selection_score": 0.28,
  "signal": "CAUTION",
  "spread_bps": 2.4
}

curl example

curl https://api.slipyard.io/api/v1/score/v2/TSLA \
  -H "X-API-Key: YOUR_API_KEY"

Signals

EXECUTE

Score 70–100

Good conditions. Low spread, normal volume. Execute your trade.

CAUTION

Score 40–69

Proceed carefully. Wider spreads or unusual volume. Monitor conditions before executing.

WAIT

Score 0–39

Poor conditions. High spread, low liquidity, or adverse flow detected. Delay execution.

Pricing

$99 /month Dev / API

✓ Unlimited API calls
✓ Unlimited API keys
✓ All endpoints included
✓ Priority support

Subscribe →