Harbour API v1.0.0

Get current rate limit status

Returns the current rate limit counters and remaining quota for the authenticated user.

GET https://harbour-api.equitydatascience.com/datapull/rate-limit-info
eds-api-key: <your-api-key>

HTTP/1.1 200

{
  "rate_limiter": "slowapi",
  "info": {
    "auth_id": "jdoe",
    "auth_type": "username",
    "fund_id": "eds100",
    "redis_source": "graphite_redis",
    "limits": {
      "minute": {
        "used": 15,
        "limit": 5000
      },
      "hour": {
        "used": 100,
        "limit": 30000
      },
      "day": {
        "used": 200,
        "limit": 60000
      }
    }
  }
}

Factor Exposures

Returns factor exposure data for a portfolio, including Z-scores, volatility-adjusted exposures, variance contributions, 30-day returns, and annualized volatility. Results are grouped by factor group (Market, Risk Indices, Industries, Countries, Currencies).

POST https://harbour-api.equitydatascience.com/datapull/v1/api/nexus_factors
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund A",
  "factorModel": "GEMTRD",
  "aumType": "aum",
  "benchmark": null,
  "proxyToStreet": false,
  "currencyHedge": false
}

HTTP/1.1 200

[
  {
    "Factor Group": "Market",
    "Factors": "World",
    "Z-Score": 2.0422,
    "Vol Adj Exp (Daily)": 0.014651,
    "% of Total Variance": 0.627096,
    "Ret (30D)": 0.028855,
    "Vol (Ann)": 0.113888
  },
  {
    "Factor Group": "Risk Indices",
    "Factors": "Beta",
    "Z-Score": 0.949855,
    "Vol Adj Exp (Daily)": 0.002932,
    "% of Total Variance": 0.107569,
    "Ret (30D)": -7.5e-05,
    "Vol (Ann)": 0.049004
  }
]

Portfolio Summary

Returns portfolio summary metrics including positions, AUM, exposures, beta, volatility, VaR, and IRR. Results are returned in Dollar and Percent sections. Optional valueType filter accepts: "$", "%", "Dollar", "Percent".

POST https://harbour-api.equitydatascience.com/datapull/v1/api/nexus_summary
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund A",
  "factorModel": "GEMTRD",
  "aumType": "aum"
}

HTTP/1.1 200

{
  "Dollar": {
    "Total Positions": 19,
    "Longs": 19,
    "Shorts": 0,
    "AUM": 617375528.86,
    "Gross": 1260804305.04,
    "Net": 1260804305.04,
    "Beta Net": 1565013113.15,
    "Vol Ann": 206328565.32,
    "VaR Ann": 339389857.1,
    "IRR": 0.492365
  },
  "Percent": {
    "Total Positions": 19,
    "Longs": 19,
    "Shorts": 0,
    "AUM": 1.0,
    "Gross": 2.0422,
    "Net": 2.0422,
    "Beta Net": 2.534945,
    "Vol Ann": 0.334203,
    "VaR Ann": 0.54973,
    "IRR": 0.492365
  }
}

Available Grid Columns

Returns all available column definitions for the portfolio grid, grouped by source (e.g., Risk, Fundamentals, Holdings). Use the variable_name values as input for the nexus_portfolio_grid endpoint's columnNames parameter.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/columns
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "rawPriceTargets": true
}

HTTP/1.1 200

{
  "Risk": [
    {
      "display_name": "% of Variance",
      "variable_name": "grid_pct_variance",
      "tooltip": "% of Variance",
      "data_type": "percent",
      "has_history": false
    },
    {
      "display_name": "Contrib to Portfolio Vol",
      "variable_name": "grid_vol_contri",
      "tooltip": "Contribution to Portfolio Vol",
      "data_type": "number",
      "has_history": false
    }
  ],
  "Holdings": [
    {
      "display_name": "Ticker",
      "variable_name": "ticker",
      "tooltip": "Ticker",
      "data_type": "string",
      "has_history": false
    }
  ]
}

Portfolio Grid Data

Returns portfolio grid data with selectable columns. Pass columnNames as an array of variable names (e.g., ["ticker", "priceusd", "country"]). Use the columns endpoint to discover available variable names. When portfolio is passed as an array of securities, null values are returned for Quantity, AUM, % of Gross, Ticker, % of AUM, Invested ($M), Strategy, and Gross.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/nexus_portfolio_grid
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund A",
  "factorModel": "GEMTRD",
  "aumType": "aum",
  "columnNames": [
    "ticker",
    "priceusd",
    "country"
  ]
}

HTTP/1.1 200

[
  {
    "ticker": "CRH US",
    "grid_pct_factor": 0.009876
  },
  {
    "ticker": "AMZN US",
    "grid_pct_factor": 0.062986
  },
  {
    "ticker": "BAC US",
    "grid_pct_factor": 0.047578
  }
]

Portfolio Optimizer

Optimizes portfolio allocations using various objective functions and constraints. objectiveFunction values: "maximumIdio", "maximumExpReturn", "minimumTrading", "balancedVariance", "riskPriority". Constraints include portfolio-level (maxTurnover, maxVol, maxNetExposure, etc.), position-level (maxLongPosition, maxShortPosition), risk (minIdio, factorConstraints), beta (maxNetBeta, minNetBeta), and holdings (maxLongHoldings, maxShortHoldings).

POST https://harbour-api.equitydatascience.com/datapull/v1/api/nexus_optimizer
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": [
    [
      "CRH US",
      0.1646
    ],
    [
      "COF US",
      0.1418
    ],
    [
      "AMZN US",
      0.1157
    ],
    [
      "BAC US",
      0.1099
    ]
  ],
  "factorModel": "GEMTRD",
  "aum": 10000000,
  "aumType": "aum",
  "objectiveFunction": "minimumTrading",
  "constraints": {
    "maxVol": 16,
    "maxNetExposure": 8,
    "minNetExposure": -8,
    "minGrossExposure": 95,
    "maxGrossExposure": 105,
    "minIdio": 0.25
  },
  "simulateByGroup": false,
  "proxyToStreet": false,
  "currencyHedge": true
}

HTTP/1.1 200

[
  {
    "ticker": "CRH US",
    "current_weight": 0.1646,
    "optimal_weight": 0.17,
    "trade": 0.0054
  },
  {
    "ticker": "COF US",
    "current_weight": 0.1418,
    "optimal_weight": 0.14,
    "trade": -0.0018
  }
]

Portfolio Holdings

Returns the current holdings for a portfolio.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/holdings
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund A"
}

HTTP/1.1 200

[
  {
    "factset_id": "0P000003MH",
    "bbg_ticker": "AAPL US",
    "security_type": "Common Stock",
    "figi": "BBG000B9XRY4"
  },
  {
    "factset_id": "0HGQ8W-E",
    "bbg_ticker": "MSFT US",
    "security_type": "Common Stock",
    "figi": "BBG000BPH459"
  },
  {
    "factset_id": "MH33D6-R",
    "bbg_ticker": null,
    "security_type": null,
    "figi": null
  }
]

Portfolio Data

Returns portfolio position data including factset_id, ticker, description, pct_aum, instrument_type, and all portfolio primary key (PPK) columns for the specified portfolio. Paginated at 500 records per page. Response includes data array, total record count, page number, and total pages.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/portfolio_data
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund A",
  "page": 1,
  "as_of_date": null
}

HTTP/1.1 200

{
  "data": [
    {
      "factset_id": "0P000003MH",
      "ticker": "AAPL US",
      "description": "Apple Inc.",
      "pct_aum": 0.0523,
      "instrument_type": "Common Stock",
      "strategy": "Long Only"
    },
    {
      "factset_id": "0HGQ8W-E",
      "ticker": "MSFT US",
      "description": "Microsoft Corp.",
      "pct_aum": 0.0412,
      "instrument_type": "Common Stock",
      "strategy": "Long Only"
    }
  ],
  "total": 750,
  "page": 1,
  "total_pages": 2,
  "portfoliodate": "2025-12-04"
}

Saved Nexus Bookmarks

Returns the list of saved Nexus bookmarks (views) for the authenticated user. Includes both user-owned bookmarks and shared (grouped) bookmarks visible to the user's fund. Use the returned viewId values to load saved portfolio views. No request body parameters are required.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/nexus_bookmarks
eds-api-key: <your-api-key>
Content-Type: application/json

HTTP/1.1 200

[
  {
    "viewId": 42,
    "viewName": "My Risk View",
    "sharedWithMe": false
  },
  {
    "viewId": 87,
    "viewName": "Team Factor View",
    "sharedWithMe": true
  }
]

Column Data Values

Returns calculated column values for securities in a portfolio. Resolves each data key through a hybrid lookup: if the key exists as a generic config column (e.g., FactSet fundamentals), the financial data source is used; otherwise it falls back to fund-scoped internal data. Use the columns or internal_data_key_list endpoints to discover available data keys.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/columns_data
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "identifier": [
    "AAPL US",
    "GOOGL US"
  ],
  "data_key": [
    "priceusd",
    "country",
    "sector"
  ]
}

HTTP/1.1 200

[
  {
    "identifier": "AAPL US",
    "priceusd": 189.3,
    "country": "UNITED STATES",
    "sector": "Information Technology"
  },
  {
    "identifier": "GOOGL US",
    "priceusd": 415.2,
    "country": "UNITED STATES",
    "sector": "Communication Services"
  }
]

Factor Model Proxy Mappings

Returns factor model proxy mappings for the authenticated user's fund. Each mapping shows the original security, its proxy, and a description. No request body parameters are required.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/proxy_mappings
eds-api-key: <your-api-key>
Content-Type: application/json

HTTP/1.1 200

[
  {
    "proxied_factsetid": "AAPL-USA",
    "factset_id": "MSFT-USA",
    "description": "Apple Inc."
  }
]

Intraday Return & Factor Attribution

Returns intraday return and factor attribution data per security. Response columns include intraday_return_percent, intraday_return_amount, factor_return_contribution_percent, factor_return_contribution_amount, idio_return_contribution_percent, idio_return_contribution_amount, currency_return_contribution_percent, currency_return_contribution_amount, and their unweighted variants. Requires Redis intraday ticker/factor returns to be populated. When the factor model does not cover securities, factor contribution columns are returned as null. When as_of_date is provided, only ticker stubs (factsetId) are returned without intraday columns, since intraday data is only available for the current trading session.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/nexus_intraday
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund A",
  "factorModel": "GEMTRD",
  "aumType": "aum",
  "currencyHedge": false
}

HTTP/1.1 200

[
  {
    "factsetId": "0P000003MH",
    "index": 0,
    "intraday_return_percent": 0.000523,
    "intraday_return_amount": 0.322891,
    "factor_return_contribution_percent": 0.000312,
    "factor_return_contribution_amount": 0.192654,
    "idio_return_contribution_percent": 0.000211,
    "idio_return_contribution_amount": 0.130237,
    "currency_return_contribution_percent": 0.0,
    "currency_return_contribution_amount": 0.0,
    "unweighted_return_intraday": 0.00312,
    "unweighted_factor_return": 0.00186,
    "unweighted_idio_return": 0.00126,
    "unweighted_currency_return": 0.0,
    "pctequity": 0.1676
  }
]

MyPortfolio Widget Data

Returns data for a specified MyPortfolio widget. Only portfolio names are supported (not array format). Filters must match exactly as they appear on the widget in the MyPortfolio page.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/myportfolio
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "widgetName": "Category Risk Contribution",
  "portfolio": "Fund B",
  "factorModel": "GEMTRD",
  "aumType": "aum",
  "benchmark": null,
  "adrProxies": false,
  "currencyHedge": true,
  "lookthrough": false
}

HTTP/1.1 200

[
  {
    "Sector (GICS)": "Health Care",
    "Net Portfolio Exposure": "18.14%",
    "Net Beta Exposure": "14.19%",
    "Portfolio Vol": "4.33%",
    "Idio Vol": "2.0%",
    "% of Variance": "36.71%",
    "% of Idio": "19.71%",
    "Idio % of Variance": "7.8%"
  },
  {
    "Sector (GICS)": "Industrials",
    "Net Portfolio Exposure": "7.58%",
    "Net Beta Exposure": "10.23%",
    "Portfolio Vol": "3.21%",
    "Idio Vol": "2.25%",
    "% of Variance": "20.23%",
    "% of Idio": "24.96%",
    "Idio % of Variance": "9.87%"
  }
]

Available Charting Metrics

Returns available charting metric groups and their individual metrics. Use the metric_id values in the charting endpoint's selected_metrics parameter.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/charting_metrics
eds-api-key: <your-api-key>
Content-Type: application/json

HTTP/1.1 200

[
  {
    "metric_group_id": "8a9d15e4-...",
    "metric_group_name": "Z-Score",
    "metrics": [
      {
        "metric_id": "002d1f73-...",
        "display_name": "Market Z-Score"
      }
    ]
  },
  {
    "metric_group_id": "d5f529c9-...",
    "metric_group_name": "Exposures %",
    "metrics": [
      {
        "metric_id": "05b79b4c-...",
        "display_name": "Net Exposure %"
      }
    ]
  }
]

Available Charting Assets

Returns available charting asset groups (Factors, Securities, Portfolios) and their individual assets. Use the asset_id values in the charting endpoint's selected_asset parameter.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/charting_assets
eds-api-key: <your-api-key>
Content-Type: application/json

HTTP/1.1 200

[
  {
    "asset_group_id": "48241bca-...",
    "asset_group_name": "Factors",
    "assets": [
      {
        "asset_id": "000e91f7-...",
        "display_name": "Market"
      }
    ]
  },
  {
    "asset_group_id": "be82d163-...",
    "asset_group_name": "Securities",
    "assets": [
      {
        "asset_id": "0A8QVM-D",
        "display_name": "S&P 500"
      }
    ]
  },
  {
    "asset_group_id": "c86fb42d-...",
    "asset_group_name": "Portfolios",
    "assets": [
      {
        "asset_id": "eds100_1",
        "display_name": "Fund C"
      }
    ]
  }
]

Chart Data

Returns time-series chart data for selected metrics and assets. Use charting_metrics and charting_assets endpoints to discover available metric_id and asset_id values.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/charting
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund B",
  "factorModel": "GEMTRD",
  "selected_asset": "eds100_fund1",
  "selected_metrics": [
    {
      "metric_id": "17cbff15-7c37-4e61-8069-649fe94bb936"
    },
    {
      "metric_id": "d5e57964-0388-4532-9a55-33a8c50d4ea3"
    }
  ],
  "daterange": {
    "start_date": "2024-10-01",
    "end_date": "2025-09-11"
  },
  "globalSettings": {
    "lookThrough": false,
    "proxyToStreet": false,
    "currencyHedge": true,
    "relatedSecuritiesProxies": false
  },
  "aumType": "aum"
}

HTTP/1.1 200

{
  "data": [
    {
      "date": "2024-10-01",
      "17cbff15-...": 0.0512,
      "d5e57964-...": 1.245
    },
    {
      "date": "2024-10-02",
      "17cbff15-...": 0.0498,
      "d5e57964-...": 1.251
    }
  ],
  "selected_metrics": [
    {
      "metric_id": "17cbff15-...",
      "display_name": "Net Exposure %"
    },
    {
      "metric_id": "d5e57964-...",
      "display_name": "Gross Exposure %"
    }
  ]
}

Available Internal Data Keys

Returns all available internal data field IDs for your fund. Use these data_key values in the internal_data_history endpoint. No request body parameters are required.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/internal_data_key_list
eds-api-key: <your-api-key>
Content-Type: application/json

HTTP/1.1 200

[
  {
    "source": "Excel Push",
    "data key": "30D CONSENSUS EPS REVISION"
  },
  {
    "source": "Excel Push",
    "data key": "ABSOLUTE FCF YIELD"
  },
  {
    "source": "Excel Push",
    "data key": "BLOOMBERG_TICKER"
  }
]

Internal Data History

Returns historical internal data for securities or portfolios. Use either identifiers (array of tickers) or portfolio (portfolio name), but not both. Pass data_keys as an array of field IDs to retrieve. Optional start_date and end_date in YYYY-MM-DD format.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/internal_data_history
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "portfolio": "Fund B",
  "data_keys": [
    "EBIT_FY2026Q1"
  ],
  "start_date": "2024-09-10",
  "end_date": "2025-11-29"
}

HTTP/1.1 200

{
  "2330 TT": [
    {
      "date": "2025-11-07",
      "EBIT_FY2026Q1": 524626.73
    },
    {
      "date": "2025-11-14",
      "EBIT_FY2026Q1": 521948.19
    }
  ],
  "AMZN US": [
    {
      "date": "2025-11-07",
      "EBIT_FY2026Q1": 32150.25
    }
  ]
}

price_targets

POST https://harbour-api.equitydatascience.com/datapull/v1/api/price_targets
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "identifier": "AAPL US",
  "portfolio": "Fund A"
}

HTTP/1.1 200

[
  {
    "price": 220.0,
    "probability": 0.6,
    "title": "Bull Case",
    "comment": "Strong earnings growth expected.",
    "targetDate": "2025-12-31",
    "identifier": "AAPL US",
    "figi": "BBG000B9XRY4",
    "analyst": "Jane Smith"
  },
  {
    "price": 160.0,
    "probability": 0.25,
    "title": "Bear Case",
    "comment": "Margin compression risk.",
    "targetDate": "2025-12-31",
    "identifier": "AAPL US",
    "figi": "BBG000B9XRY4",
    "analyst": "Jane Smith"
  }
]

EDS Construction Dashboard

Returns data from the EDS Construction Dashboard for a specified view. Pass view as the view name (e.g., "summary dashboard"). Optionally filter by watchlist or portfolio names.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/research_grid
eds-api-key: <your-api-key>
Content-Type: application/json

{
  "view": "summary dashboard",
  "watchlist": "Sample Watchlist"
}

HTTP/1.1 200

[
  {
    "Ticker": "AMZN US",
    "Strategy": "Long/Short",
    "Instrument Type": "CommonStock",
    "Direction": "Long",
    "Name": "Amazon.com, Inc.",
    "Sector": "Consumer Discretionary",
    "Current Value USD": 5.112698
  }
]

Saved Views

Returns all saved views accessible to the authenticated user. Each view includes its name, type, associated watchlists/portfolios, and column configuration. No request body parameters are required.

POST https://harbour-api.equitydatascience.com/datapull/v1/api/views
eds-api-key: <your-api-key>
Content-Type: application/json

HTTP/1.1 200

[
  {
    "view_name": "summary dashboard",
    "view_type": "watchlist",
    "watchlist": "Sample Watchlist"
  }
]