DocsAPI reference

Reference

API reference

Every endpoint Creo serves, generated from the live OpenAPI 3.1 schema on each request, so this page always matches production.

Base URL https://itscreo.com. Send JSON with content-type: application/json and your key in x-api-key. Errors share one body; see Errors.

Endpoints

POST/v1/scores

Scores No key needed

Fundamental factor z-scores, percentiles and labels for up to 50 tickers keyless or with a free key, or the plan's limit (200) with a Builder or Pro key. Built only from SEC EDGAR filings, so no prices are needed. Positive z means the factor's named tilt (see `high_means`). Unscored tickers carry a reason code. A past `as_of` needs the Builder plan (403 PLAN_REQUIRED otherwise).

Request body

tickersarray of stringrequired
as_ofdatenullable

Example

curl -X POST https://itscreo.com/v1/scores \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 200Successful Response creo__tape__models__ScoreBatch
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
Response fields
as_ofdaterequired
computed_atdatetimerequired
methodology_versionstringrequired
universeUniverseInforequired
Child fields
namestringrequired
sizeintegerrequired

US-listed issuers (unique CIKs) in SEC's ticker file

scoredintegerrequired

Issuers with a current fundamental snapshot

estimationintegerrequired

Issuers that set the cross-sectional moments

descriptionstringrequired
quality_flagsarray of stringrequired
factorsarray of FactorInforequired
Child fields
idstringrequired
labelstringrequired
short_labelstringrequired
high_meansstringrequired
low_meansstringrequired
descriptionstringrequired
raw_labelstringrequired
unitstringrequired
scoresmaprequired
unknown_tickersarray of stringrequired

GET/v1/scores/factors

Score Factors No key needed

Example

curl https://itscreo.com/v1/scores/factors

Responses

  • 200Successful Response
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error

GET/v1/scores/history

Score History No key needed

Point-in-time factor z per quarter-end, oldest first. Needs the Builder plan (as_of_history). The /portfolio page's Investor-entitled, invited or connected browsers get the last 8 quarters without a key. Each date uses only filings filed by then. Funds apply their latest N-PORT holdings.

query parameter tickers: Comma-separated tickers

query parameter quarters:

Example

curl https://itscreo.com/v1/scores/history

Responses

  • 200Successful Response HistoryResponse
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
Response fields
methodology_versionstringrequired
history_versionintegerrequired
methodstringrequired
datesarray of daterequired

Calendar quarter-ends, oldest first

factorsarray of stringrequired
quality_flagsarray of stringrequired
tickersmaprequired
unknown_tickersarray of stringrequired

GET/v1/scores/export

Score Export No key needed

Every scored US-listed ticker as gzipped NDJSON: {as_of, ticker, cik, company, exchange, factors: {id: [z, percentile]}} per line. Streamed; supports If-None-Match.

query parameter as_of:

Example

curl https://itscreo.com/v1/scores/export

Responses

  • 200Successful Response
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error

GET/v1/scores/ranked

Ranked No key needed

Listed companies with the highest or lowest z on one factor, most extreme first.

query parameter factor: Factor id from /v1/scores/factors

query parameter direction:

query parameter min_float_usd: Minimum SEC-reported public float, USD

query parameter limit:

query parameter exclude: Comma-separated tickers to leave out

Example

curl https://itscreo.com/v1/scores/ranked

Responses

  • 200Successful Response RankedResponse
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
Response fields
factorstringrequired
labelstringrequired
directionenumrequired

One of high, low

meansstringrequired

What the chosen direction means (high_means or low_means)

min_float_usdnumberrequired
computed_atdatetimerequired
methodology_versionstringrequired
eligibleintegerrequired

Scored listed issuers that passed the filters

issuersarray of RankedIssuerrequired

Most extreme first

Child fields
tickerstringrequired
cikstringrequired
companystringrequired
exchangestringrequired
znumberrequired
percentilenumberrequired

0-100 within the scored universe

labelstringrequired
public_float_usdnumberrequired

dei:EntityPublicFloat from the latest 10-K cover, USD

GET/v1/scores/benchmark

Score Benchmark No key needed

US market factor exposures: public-float-weighted and equal-weighted mean z.

Example

curl https://itscreo.com/v1/scores/benchmark

Responses

  • 200Successful Response BenchmarkResponse
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
Response fields
as_ofdaterequired
computed_atdatetimerequired
methodology_versionstringrequired
namestringrequired
methodstringrequired
issuersintegerrequired
float_issuersintegerrequired
total_public_float_usdnumberrequired
quality_flagsarray of stringrequired
factorsarray of BenchmarkFactorrequired
Child fields
factorstringrequired
labelstringrequired
float_weightednumberrequired

Public-float-weighted mean z

equal_weightednumberrequired

Equal-weighted mean z

float_weighted_labelstringrequired
issuersintegerrequired

Issuers with this factor in the float-weighted mean

GET/v1/universe

Universe No key needed

Every US-listed ticker in SEC's file as [ticker, name, exchange], for autocomplete.

Example

curl https://itscreo.com/v1/universe

Responses

  • 200Successful Response
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error

GET/v1/tape

Tape No key needed

Recent EDGAR filings by US-listed issuers and how each moved its factor scores. Poll with `after` set to the last `cursor` to get only new or updated events. With `tickers`, only filings by those issuers (any share class) are returned.

query parameter tickers: Comma-separated, up to 200

query parameter after:

query parameter limit:

Example

curl https://itscreo.com/v1/tape

Responses

  • 200Successful Response TapeResponse
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
Response fields
generated_atdatetimerequired
methodology_versionstringrequired
livebooleanrequired

EDGAR feed polled successfully in the last 10 minutes

last_poll_atdatetimerequired
cursorintegerrequired

Pass as ?after= to get only newer events

eventsarray of TapeEventrequired
Child fields
seqintegerrequired
accessionstringrequired
cikstringrequired
tickerstringrequired
companystringrequired
formstringrequired
itemsarray of stringrequired
accepted_atdatetimerequired
time_precisionenum

"day" when only the filing date is known

One of second, day

Default "second"

observed_atdatetimerequired
kindenumrequired

One of scored, new, unchanged, earnings_release, no_xbrl

period_enddaterequired
urlstringrequired
changesarray of TapeChangerequired
Child fields
factorstringrequired
short_labelstringrequired
znumberrequired
deltanumberrequired
labelstringrequired
scored_issuersinteger

Default 0

POST/v1/keys

Mint a free API key No key needed

Returns a new key once; Creo stores only its hash. No auth needed. Limited to 5 keys per IP per UTC day, so reuse your key (for example from a CREO_KEY environment variable) instead of minting per run.

Request body

Example

curl -X POST https://itscreo.com/v1/keys \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 201Successful Response IssuedKey
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 429RATE_LIMITED: 5 new keys per IP per day Error
Response fields
keystringrequired

The secret. Shown once; Creo stores only a hash.

idstringrequired
namestringnullable
key_prefixstringrequired
planstringrequired
daily_call_limitintegerrequired
max_positionsintegerrequired
created_atdatetimerequired

GET/v1/plans

Plans No key needed

Example

curl https://itscreo.com/v1/plans

Responses

  • 200Successful Response PlanCatalog
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
Response fields
plansarray of Planrequired

API plans for keys: Free, Builder and Pro.

Child fields
idstringrequired
namestringrequired
monthly_usdintegerrequired
daily_call_limitintegerrequired
max_positionsintegerrequired
summarystringrequired
featuresarray of PlanFeature
Child fields
textstringrequired
enforced_byarray of stringrequired

How Creo enforces it: gate:<feature> (a plan check on the route), limit:daily_call_limit or limit:max_positions, includes:<plan>, included (every key gets it) or terms (the license, not a technical limit).

checkout_openbooleanrequired

True once API plans can be bought.

investorInvestorCatalogrequired

Creo Investor, the separate retail plan for the web analyzer.

Child fields
checkout_openbooleanrequired

True once Investor can be bought.

plansarray of InvestorPlanrequired
Child fields
idstringrequired
namestringrequired
monthly_usdintegerrequired
yearly_usdintegerrequired

Price when billed yearly, for the whole year.

summarystringrequired
featuresarray of PlanFeaturerequired
Child fields
textstringrequired
enforced_byarray of stringrequired

How Creo enforces it: gate:<feature> (a plan check on the route), limit:daily_call_limit or limit:max_positions, includes:<plan>, included (every key gets it) or terms (the license, not a technical limit).

GET/v1/status

Service status, methodology version and data sources No key needed

Keyless and free. Reads process state only; never touches the database.

Example

curl https://itscreo.com/v1/status

Responses

  • 200Successful Response ServiceStatus
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
Response fields
statusanyrequired

degraded when any component is degraded.

checked_atanyrequired
started_atanyrequired
versionanyrequired
commitanyrequired

Short git commit of the running deploy.

methodology_versionanyrequired
factorsanyrequired
demoanyrequired
componentsanyrequired
data_sourcesanyrequired
attestationanyrequired

GET/v1/account

Account Requires a key

Example

curl https://itscreo.com/v1/account \
  -H "x-api-key: $CREO_KEY"

Responses

  • 200Successful Response AccountStatus
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
Response fields
account_idstringrequired
key_idstringrequired
key_namestringrequired
key_prefixstringrequired
recovery_emailstringrequired
recovery_availablebooleanrequired

False while Creo has no outgoing email configured.

planPlanrequired
Child fields
idstringrequired
namestringrequired
monthly_usdintegerrequired
daily_call_limitintegerrequired
max_positionsintegerrequired
summarystringrequired
featuresarray of PlanFeature
Child fields
textstringrequired
enforced_byarray of stringrequired

How Creo enforces it: gate:<feature> (a plan check on the route), limit:daily_call_limit or limit:max_positions, includes:<plan>, included (every key gets it) or terms (the license, not a technical limit).

subscription_planstringrequired
subscription_statusstringrequired
current_period_enddatetimerequired
cancel_at_period_endbooleanrequired
can_manage_billingbooleanrequired
calls_used_todayintegerrequired
reset_atdatetimerequired

POST/v1/account/checkout

Account Checkout Requires a key

Request body

planenumrequired

One of builder, pro

Example

curl -X POST https://itscreo.com/v1/account/checkout \
  -H "x-api-key: $CREO_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 200Successful Response BillingRedirect
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
Response fields
urlstringrequired

POST/v1/account/portal

Account Portal Requires a key

Example

curl -X POST https://itscreo.com/v1/account/portal \
  -H "x-api-key: $CREO_KEY"

Responses

  • 200Successful Response BillingRedirect
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
Response fields
urlstringrequired

GET/v1/account/keys

List this account's keys Requires a key

Every key on the account with its prefix, created and last-used times and state.

Example

curl https://itscreo.com/v1/account/keys \
  -H "x-api-key: $CREO_KEY"

Responses

  • 200Successful Response KeyList
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
Response fields
keysarray of KeyInforequired
Child fields
idstringrequired
namestringrequired
key_prefixstringrequired
stateenumrequired

One of active, expiring, expired, revoked

created_atdatetimerequired
last_used_atdatetimerequired
expires_atdatetimerequired

Set while a rotated key overlaps with its replacement.

revoked_atdatetimerequired
currentbooleanrequired

True for the key that made this request.

max_active_keysinteger

Default 10

POST/v1/account/keys

Create another key on this account Requires a key

Shares the account's plan and daily credits. The secret is returned once.

Request body

Example

curl -X POST https://itscreo.com/v1/account/keys \
  -H "x-api-key: $CREO_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 201Successful Response IssuedKey
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
  • 409KEY_LIMIT: 10 active keys, or LAST_KEY Error
Response fields
keystringrequired

The secret. Shown once; Creo stores only a hash.

idstringrequired
namestringnullable
key_prefixstringrequired
planstringrequired
daily_call_limitintegerrequired
max_positionsintegerrequired
created_atdatetimerequired

POST/v1/account/keys/{key_id}/rotate

Rotate a key, optionally keeping the old one working for a while Requires a key

Issues a replacement with the same name. With expires_in_hours the old key keeps working until then; with 0 (the default) it stops immediately.

path parameter key_id:

Request body

Example

curl -X POST https://itscreo.com/v1/account/keys/{key_id}/rotate \
  -H "x-api-key: $CREO_KEY" \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 201Successful Response RotatedKey
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
  • 404KEY_NOT_FOUND: not a key on this account Error
Response fields
new_keyIssuedKeyrequired
Child fields
keystringrequired

The secret. Shown once; Creo stores only a hash.

idstringrequired
namestringnullable
key_prefixstringrequired
planstringrequired
daily_call_limitintegerrequired
max_positionsintegerrequired
created_atdatetimerequired
old_keyKeyInforequired
Child fields
idstringrequired
namestringrequired
key_prefixstringrequired
stateenumrequired

One of active, expiring, expired, revoked

created_atdatetimerequired
last_used_atdatetimerequired
expires_atdatetimerequired

Set while a rotated key overlaps with its replacement.

revoked_atdatetimerequired
currentbooleanrequired

True for the key that made this request.

DELETE/v1/account/keys/{key_id}

Revoke a key Requires a key

Stops the key at once. The account's last active key cannot be revoked.

path parameter key_id:

Example

curl -X DELETE https://itscreo.com/v1/account/keys/{key_id} \
  -H "x-api-key: $CREO_KEY"

Responses

  • 200Successful Response KeyInfo
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
  • 404KEY_NOT_FOUND: not a key on this account Error
  • 409KEY_LIMIT: 10 active keys, or LAST_KEY Error
Response fields
idstringrequired
namestringrequired
key_prefixstringrequired
stateenumrequired

One of active, expiring, expired, revoked

created_atdatetimerequired
last_used_atdatetimerequired
expires_atdatetimerequired

Set while a rotated key overlaps with its replacement.

revoked_atdatetimerequired
currentbooleanrequired

True for the key that made this request.

GET/v1/account/usage

Daily calls and credits for 30 days, and recent requests Requires a key

Account-wide by default; pass key_id for one key. Free, never charged.

query parameter key_id:

Example

curl https://itscreo.com/v1/account/usage \
  -H "x-api-key: $CREO_KEY"

Responses

  • 200Successful Response AccountUsage
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
Response fields
key_idstringrequired

The key filtered on, or null for every key.

daysarray of UsageDayrequired

The last 30 UTC days, oldest first.

Child fields
daydaterequired
callsintegerrequired

Scored calls attempted, including rate-limited ones.

creditsintegerrequired

Credits charged after refunds.

requestsarray of LoggedRequestrequired

The 100 most recent scored calls.

Child fields
atdatetimerequired
key_idstringrequired
key_prefixstringrequired
methodstringrequired
routestringrequired
statusintegerrequired
creditsintegerrequired
request_idstringrequired
log_retentionstring

Default "Scored calls from the last 30 days, up to 1,000 per account."

PUT/v1/account/recovery-email

Set or remove the account's recovery email Requires a key

Request body

emailstringrequired

Where recovery links go; null removes it.

Example

curl -X PUT https://itscreo.com/v1/account/recovery-email \
  -H "x-api-key: $CREO_KEY"

Responses

  • 200Successful Response AccountStatus
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
Response fields
account_idstringrequired
key_idstringrequired
key_namestringrequired
key_prefixstringrequired
recovery_emailstringrequired
recovery_availablebooleanrequired

False while Creo has no outgoing email configured.

planPlanrequired
Child fields
idstringrequired
namestringrequired
monthly_usdintegerrequired
daily_call_limitintegerrequired
max_positionsintegerrequired
summarystringrequired
featuresarray of PlanFeature
Child fields
textstringrequired
enforced_byarray of stringrequired

How Creo enforces it: gate:<feature> (a plan check on the route), limit:daily_call_limit or limit:max_positions, includes:<plan>, included (every key gets it) or terms (the license, not a technical limit).

subscription_planstringrequired
subscription_statusstringrequired
current_period_enddatetimerequired
cancel_at_period_endbooleanrequired
can_manage_billingbooleanrequired
calls_used_todayintegerrequired
reset_atdatetimerequired

POST/v1/account/recover

Email a recovery link No key needed

No key needed. Always 202 when recovery is on, whether or not the email matches an account, so it cannot reveal who holds one.

Request body

emailstringrequired

Example

curl -X POST https://itscreo.com/v1/account/recover \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 202Successful Response
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 429RATE_LIMITED: 5 requests per IP per day Error
  • 503RECOVERY_UNAVAILABLE: outgoing email is off Error

POST/v1/account/recover/redeem

Mint a new key from a recovery link No key needed

Single use, valid 30 minutes. Existing keys keep working; revoke lost ones after.

Request body

tokenstringrequired

The token from the link.

Example

curl -X POST https://itscreo.com/v1/account/recover/redeem \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 201Successful Response IssuedKey
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 410RECOVERY_LINK_INVALID: expired or already used Error
Response fields
keystringrequired

The secret. Shown once; Creo stores only a hash.

idstringrequired
namestringnullable
key_prefixstringrequired
planstringrequired
daily_call_limitintegerrequired
max_positionsintegerrequired
created_atdatetimerequired

GET/v1/demo/exposures

Score the five SYNTH.* demo tickers Key optional

Works without a key (20 calls a day per IP) or with one (1 credit).

Example

curl https://itscreo.com/v1/demo/exposures

Responses

  • 200Successful Response PublicExposureResponse
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
  • 429RATE_LIMITED: daily credits used up Error
Response fields
result_idanyrequired
methodology_versionanyrequired
data_policyanyrequired

synthetic_demo when every position is a SYNTH.* demo series, otherwise customer_supplied_prices. Creo sells compute, not market data.

valuation_summaryanyrequired
instrumentsanyrequired
exposuresanyrequired
riskanyrequired
not_aggregatedanyrequired
coverageanyrequired
qualityanyrequired
warningsanyrequired
provenanceanyrequired
valid_atanyrequired
source_known_atanyrequired
system_known_atanyrequired
computed_atanyrequired
creditsanyrequired
sec_sourcesany

SEC EDGAR facts behind each *.sec factor value, with accession numbers.

POST/v1/portfolio/exposures

Score a portfolio for named factor exposures and risk contribution Key optional

Send positions with your own daily closes; Creo returns each factor's portfolio exposure (weights x per-position characteristic), the long and short book contributions, 63-session risk contribution, coverage, quality flags and timestamps. Missing data is null with a reason, never zero. SYNTH.* tickers without history work keyless. 1 successful call = 1 credit; typed 422s are free.

Request body

positionsarray of PublicPositionrequired

Long (quantity > 0) and short (quantity < 0) positions. The plan caps the count: Free 5, Builder 50, Pro 200.

Child fields
tickerstringrequired

Your identifier for the instrument (A-Z, 0-9, '.', '-'). Creo does not look it up; SYNTH.* tickers use built-in synthetic demo series.

quantitydecimalrequired

Signed units held. Positive is long, negative is short. Non-zero.

asset_classenum

equity or crypto. Each class is scored in its own sleeve with its own factors; the two are never added together.

One of equity, crypto

Default "equity"

closedecimalnullable

Valuation close in USD. Defaults to the last close in history.

market_capdecimalnullable

Market capitalization in USD. Needed for the size factor.

historyarray of PublicBar

Daily closes, any order. Required for every non-SYNTH ticker. /llms-full.txt lists how many closes each factor needs (up to 253).

Child fields
datedaterequired

Session date (YYYY-MM-DD).

closedecimalrequired

Close price in USD.

volumedecimalnullable

Shares (or coins) traded. Needed for the liquidity factors.

cashdecimal

Cash in USD, added to net asset value (NAV). For long/short books, send the account's cash so weights are fractions of real NAV.

Default "0"

factorsarray of stringnullable

Factor ids to compute. Default: every factor for the asset classes in the book. GET /llms.txt lists the ids.

valid_atdatetimenullable

Point-in-time cutoff in UTC (ends with Z). Bars after this date are ignored. Default: the close of the latest supplied session.

benchmarkPublicBenchmarknullable

Required for market beta and the market/residual risk split. Without it beta is null with MISSING_BENCHMARK.

Child fields
tickerstring

Label only.

Default "BENCHMARK"

historyarray of PublicBarrequired

Daily benchmark closes on the same dates as the positions' history.

Child fields
datedaterequired

Session date (YYYY-MM-DD).

closedecimalrequired

Close price in USD.

volumedecimalnullable

Shares (or coins) traded. Needed for the liquidity factors.

universeenumnullable

Label echoed as each exposure's reference_universe. v1 returns raw characteristics, not cross-sectional z-scores, so this does not change values.

One of client_supplied, demo_synthetic

Example

curl -X POST https://itscreo.com/v1/portfolio/exposures \
  -H "content-type: application/json" \
  -d '{"positions":[{"ticker":"SYNTH.MOM","quantity":"-10"},{"ticker":"SYNTH.DEF","quantity":"10"}],"cash":"5000"}'

Responses

  • 200Successful Response PublicExposureResponse
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
  • 429RATE_LIMITED: daily credits used up Error
Response fields
result_idanyrequired
methodology_versionanyrequired
data_policyanyrequired

synthetic_demo when every position is a SYNTH.* demo series, otherwise customer_supplied_prices. Creo sells compute, not market data.

valuation_summaryanyrequired
instrumentsanyrequired
exposuresanyrequired
riskanyrequired
not_aggregatedanyrequired
coverageanyrequired
qualityanyrequired
warningsanyrequired
provenanceanyrequired
valid_atanyrequired
source_known_atanyrequired
system_known_atanyrequired
computed_atanyrequired
creditsanyrequired
sec_sourcesany

SEC EDGAR facts behind each *.sec factor value, with accession numbers.

POST/v1/portfolio/scores

SEC fundamental factor z-scores for a list of tickers Key optional

Send tickers only; no quantities or values. Each factor is a cross-sectional z-score (-3..+3) against US-listed SEC filers, built from 10-K and 10-Q filings alone. Unscored tickers carry a reason code. Keyless: up to 50 tickers per call and 1000 calls a day per IP (429 RATE_LIMITED beyond). With an x-api-key each call costs one credit.

Request body

tickersarray of stringrequired
as_ofdatenullable

Example

curl -X POST https://itscreo.com/v1/portfolio/scores \
  -H "content-type: application/json" \
  -d '{}'

Responses

  • 200Successful Response creo__portfolio__scores__ScoreBatch
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
  • 429RATE_LIMITED: daily credits used up Error
Response fields
as_ofdaterequired
computed_atdatetimenullable
methodology_versionstringrequired
universeUniverserequired
Child fields
namestringrequired
sizeintegerrequired
scoredintegerrequired
descriptionstringrequired
quality_flagsarray of string
factorsarray of FactorDefinition
Child fields
idstringrequired
labelstringrequired
short_labelstringrequired
high_meansstringrequired
low_meansstringrequired
descriptionstringrequired
raw_labelstringnullable
unitstringnullable
scoresmap
unknown_tickersarray of string
creditsmapnullable

POST/v1/portfolio/analyze

Portfolio factor exposures from your holdings' values Key optional

Send tickers with market values (or weights) from your own statement. Returns value-weighted factor z-scores, each holding's contribution, coverage with reasons, and a plain-English sentence per factor. Creo does not price shares: a position with only quantity gets 422 QUANTITY_NEEDS_VALUE. Unscored holdings are left out of each mean, never counted as zero. Keyless: up to 50 positions per call and 1000 calls a day per IP (429 RATE_LIMITED beyond). With an x-api-key each call costs one credit.

Request body

positionsarray of AnalyzePositionrequired
Child fields
tickerstringrequired
market_valuenumbernullable

Signed market value in USD (negative for shorts), from your own statement. Send this or weight.

weightnumbernullable

Signed portfolio weight in any unit (0.25, or 25). Weights are renormalized, so they need not sum to 1.

quantitynumbernullable

Share count, accepted for convenience alongside market_value or weight and otherwise ignored. Creo does not price shares, so quantity alone is rejected with QUANTITY_NEEDS_VALUE.

cashnumber

Cash in the same unit; shown, never scored.

Default 0

as_ofdatenullable

Score date. Default: latest.

Example

curl -X POST https://itscreo.com/v1/portfolio/analyze \
  -H "content-type: application/json" \
  -d '{"positions":[{"ticker":"AAPL","market_value":18250},{"ticker":"MSFT","market_value":12400},{"ticker":"VTI","market_value":9000}],"cash":1500}'

Responses

  • 200Successful Response AnalyzeResponse
  • 422INVALID_REQUEST, or a typed failure such as PRICES_REQUIRED, QUANTITY_NEEDS_VALUE or POSITION_LIMIT. Not charged. Error
  • 400KEY_IN_QUERY: send the key in a header, not the URL Error
  • 401AUTHENTICATION_REQUIRED: missing or invalid key Error
  • 429RATE_LIMITED: daily credits used up Error
Response fields
as_ofdaterequired
methodology_versionstringrequired
universeUniverserequired
Child fields
namestringrequired
sizeintegerrequired
scoredintegerrequired
descriptionstringrequired
quality_flagsarray of stringrequired
headlinestringrequired
factorsarray of FactorDefinitionrequired
Child fields
idstringrequired
labelstringrequired
short_labelstringrequired
high_meansstringrequired
low_meansstringrequired
descriptionstringrequired
raw_labelstringnullable
unitstringnullable
exposuresarray of PortfolioExposurerequired
Child fields
factor_idstringrequired
labelstringrequired
short_labelstringrequired
exposurenumberrequired

Value-weighted mean z-score of covered holdings, on the -3..+3 scale.

percentilenumberrequired

Value-weighted mean of the holdings' cross-sectional percentiles (0-100).

coveragenumberrequired

Share of gross holdings value scored on this factor.

covered_holdingsintegerrequired
tiltenumrequired

One of positive, negative, neutral, unavailable

sentencestringrequired
high_meansstringrequired
low_meansstringrequired
holdingsarray of HoldingResultrequired
Child fields
tickerstringrequired
companystringrequired
weightnumberrequired

Share of total value including cash.

statusenumrequired

One of scored, partial, unscored

reasonstringrequired
factorsmaprequired
coverageCoverageSummaryrequired
Child fields
holdingsintegerrequired
scoredintegerrequired
partialintegerrequired
unscoredintegerrequired
scored_weightnumberrequired

Share of gross holdings value with any score.

cash_weightnumberrequired
unscored_by_reasonmaprequired
creditsmapnullable

Your key's plan and usage; null for keyless calls.

Health checks

GET/health/live

Live No key needed

Example

curl https://itscreo.com/health/live

Responses

  • 200Successful Response

GET/health/ready

Ready No key needed

Example

curl https://itscreo.com/health/ready

Responses

  • 200Successful Response