Prevedere Indicator API
The Indicator API from Prevedere — 9 operation(s) for indicator.
The Indicator API from Prevedere — 9 operation(s) for indicator.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/prevedere-indicator-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Board Foresight API - V1 Alert Indicator API
description: ''
version: v1
servers:
- url: https://api.prevedere.com
description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- api key: []
tags:
- name: Indicator
description: ''
paths:
/indicator/composite/definition/{Provider}/{ProviderId}:
get:
tags:
- Indicator
summary: Retrieves the definition of a composite indicator
description: Retrieves the definition for a given composite indicator in the system
parameters:
- name: Provider
in: path
description: Unique Identifier for Provider
required: true
schema:
type: string
- name: ProviderId
in: path
description: Identifier for specific indicator
required: true
schema:
type: string
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/CompositeDefinition'
application/json:
schema:
$ref: '#/components/schemas/CompositeDefinition'
text/json:
schema:
$ref: '#/components/schemas/CompositeDefinition'
'404':
description: Not Found
content:
text/plain:
schema:
$ref: '#/components/schemas/ResponseMessage'
application/json:
schema:
$ref: '#/components/schemas/ResponseMessage'
text/json:
schema:
$ref: '#/components/schemas/ResponseMessage'
'429':
description: If the user has sent too many requests
put:
tags:
- Indicator
summary: Updates the definition of a composite indicator
description: updates the definition for a given composite indicator in the system
parameters:
- name: Provider
in: path
description: Unique Identifier for Provider
required: true
schema:
type: string
- name: ProviderId
in: path
description: Identifier for specific indicator
required: true
schema:
type: string
requestBody:
description: Composite indicator definition
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CompositeDefinitionUpdateRequest'
application/json:
schema:
$ref: '#/components/schemas/CompositeDefinitionUpdateRequest'
text/json:
schema:
$ref: '#/components/schemas/CompositeDefinitionUpdateRequest'
application/*+json:
schema:
$ref: '#/components/schemas/CompositeDefinitionUpdateRequest'
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/CompositeDefinitionUpdateResponse'
application/json:
schema:
$ref: '#/components/schemas/CompositeDefinitionUpdateResponse'
text/json:
schema:
$ref: '#/components/schemas/CompositeDefinitionUpdateResponse'
'400':
description: Bad Request
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
'404':
description: Not Found
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
'429':
description: If the user has sent too many requests
/indicator/composite/definition:
post:
tags:
- Indicator
summary: Creates a composite indicator
description: creates a composite indicator
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CompositeDefinitionCreateRequest'
application/json:
schema:
$ref: '#/components/schemas/CompositeDefinitionCreateRequest'
text/json:
schema:
$ref: '#/components/schemas/CompositeDefinitionCreateRequest'
application/*+json:
schema:
$ref: '#/components/schemas/CompositeDefinitionCreateRequest'
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/CompositeDefinition'
application/json:
schema:
$ref: '#/components/schemas/CompositeDefinition'
text/json:
schema:
$ref: '#/components/schemas/CompositeDefinition'
'400':
description: Bad Request
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseMessage'
'429':
description: If the user has sent too many requests
/indicator/{Provider}/{ProviderId}:
get:
tags:
- Indicator
description: Retrieves metadata for a given indicator in the system
parameters:
- name: Provider
in: path
required: true
schema:
type: string
- name: ProviderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/Indicator'
application/json:
schema:
$ref: '#/components/schemas/Indicator'
text/json:
schema:
$ref: '#/components/schemas/Indicator'
'429':
description: If the user has sent too many requests
/indicator/series/{Provider}/{ProviderId}:
get:
tags:
- Indicator
description: Retrieves time-series data for a given indicator in the system
parameters:
- name: Provider
in: path
required: true
schema:
type: string
- name: ProviderId
in: path
required: true
schema:
type: string
- name: Calculation
in: query
schema:
type: string
- name: Frequency
in: query
schema:
type: string
- name: StartDate
in: query
schema:
type: string
- name: EndDate
in: query
schema:
type: string
- name: Offset
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Point'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Point'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Point'
'429':
description: If the user has sent too many requests
/indicator/series/transform:
post:
tags:
- Indicator
description: Retrieves time-series data for a given indicator in the system with transformations applied
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/IndicatorTransformation'
application/json:
schema:
$ref: '#/components/schemas/IndicatorTransformation'
text/json:
schema:
$ref: '#/components/schemas/IndicatorTransformation'
application/*+json:
schema:
$ref: '#/components/schemas/IndicatorTransformation'
responses:
'200':
description: OK
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Point'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Point'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Point'
'429':
description: If the user has sent too many requests
/correlation/{FixedProvider}/{FixedProviderId}/{LeadingProvider}/{LeadingProviderId}/{Frequency}/{Calculation}:
get:
tags:
- Indicator
description: Generates correlation data by comparing two indicators
parameters:
- name: FixedProvider
in: path
required: true
schema:
type: string
- name: FixedProviderId
in: path
required: true
schema:
type: string
- name: LeadingProvider
in: path
required: true
schema:
type: string
- name: LeadingProviderId
in: path
required: true
schema:
type: string
- name: Frequency
in: path
required: true
schema:
type: string
- name: Calculation
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/CorrelationSet'
application/json:
schema:
$ref: '#/components/schemas/CorrelationSet'
text/json:
schema:
$ref: '#/components/schemas/CorrelationSet'
'429':
description: If the user has sent too many requests
/search:
get:
tags:
- Indicator
description: retrieves indicators based on search criteria
parameters:
- name: Frequency
in: query
description: A frequency value to filter search results by. <seealso cref="T:Prevedere.Analytics.Domain.Enum.Frequency" />
schema:
type: string
- name: Calculation
in: query
description: A calculation value to filter search results by. <seealso cref="T:Prevedere.Analytics.Domain.Enum.Calculation" />
schema:
type: string
- name: Seasonality
in: query
description: A seasonality value to filter search results by. <seealso cref="T:Prevedere.Analytics.Domain.Enum.Seasonality" />
schema:
type: string
- name: Internal
in: query
description: A flag for returning internal company data sets
schema:
type: boolean
- name: IncludeForecasted
in: query
description: A flag for returning forecasted indicators in the search results.
schema:
type: boolean
- name: Query
in: query
required: true
schema:
type: string
default: '*'
- name: Page
in: query
schema:
type: integer
format: int32
default: 0
- name: PageSize
in: query
schema:
type: integer
format: int32
default: 25
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/IndicatorSearchResults'
application/json:
schema:
$ref: '#/components/schemas/IndicatorSearchResults'
text/json:
schema:
$ref: '#/components/schemas/IndicatorSearchResults'
'429':
description: If the user has sent too many requests
/indicator/create:
post:
tags:
- Indicator
description: creates a new indicator.
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/IndicatorCreate'
application/json:
schema:
$ref: '#/components/schemas/IndicatorCreate'
text/json:
schema:
$ref: '#/components/schemas/IndicatorCreate'
application/*+json:
schema:
$ref: '#/components/schemas/IndicatorCreate'
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/Indicator'
application/json:
schema:
$ref: '#/components/schemas/Indicator'
text/json:
schema:
$ref: '#/components/schemas/Indicator'
'429':
description: If the user has sent too many requests
/indicator/update:
put:
tags:
- Indicator
description: updates one or more indicators.
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/BulkIndicatorUpdateRequest'
application/json:
schema:
$ref: '#/components/schemas/BulkIndicatorUpdateRequest'
text/json:
schema:
$ref: '#/components/schemas/BulkIndicatorUpdateRequest'
application/*+json:
schema:
$ref: '#/components/schemas/BulkIndicatorUpdateRequest'
responses:
'200':
description: OK
'429':
description: If the user has sent too many requests
components:
schemas:
IndicatorType:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
type: integer
format: int32
Provider:
type: object
properties:
name:
type:
- string
- 'null'
description:
type:
- string
- 'null'
id:
type: string
format: uuid
source:
type:
- string
- 'null'
additionalProperties: false
CompositeEntryUpdateRequest:
type: object
properties:
provider:
type:
- string
- 'null'
description: Unique Identifier for Provider.
providerId:
type:
- string
- 'null'
description: Identifier for indicator
offset:
type: integer
description: Offset applied to indicator
format: int32
calculation:
type:
- string
- 'null'
description: Calculation of indicator
additionalProperties: false
DisplayInformation:
type: object
properties:
name:
type:
- string
- 'null'
description: The display name to be used in the application. Limited to 50 characters.
description:
type:
- string
- 'null'
description: The description to be shown in the application. Limited to 1,000 characters.
color:
type:
- string
- 'null'
description: The color to use in the application. Must be a valid hex color code.
category:
type:
- string
- 'null'
description: The category of the indicator. Limited to 1,000 characters.
additionalProperties: false
Transformation:
type: object
properties:
order:
type: integer
format: int32
required:
type: boolean
additionalProperties: false
IndicatorSearchResults:
type: object
properties:
results:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Indicator'
readOnly: true
page:
type: integer
format: int32
readOnly: true
pageSize:
type: integer
format: int32
readOnly: true
totalResults:
type: integer
format: int64
readOnly: true
additionalProperties: false
IndicatorCreateRequest:
type: object
properties:
provider:
type:
- string
- 'null'
description: Unique identifier for provider
providerId:
type:
- string
- 'null'
description: Indicator Identifier
name:
type:
- string
- 'null'
description: Indicator Name
description:
type:
- string
- 'null'
description: Indicator Description
notes:
type:
- string
- 'null'
description: Indicator Notes
units:
type:
- string
- 'null'
description: Indicator Units of measurement
citation:
type:
- string
- 'null'
description: Indicator Citation
path:
type:
- string
- 'null'
description: Path of indicator in Prevedere folder structure
color:
type:
- string
- 'null'
description: Color code to be used in the Prevedere application
aggregation:
type:
- string
- 'null'
description: Aggregation method used for indicator time series
tags:
type:
- array
- 'null'
items:
type: string
description: Tags assigned to help organize indicator
industryCodes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/IndustryCode'
description: Industry codes assigned to indicator
classification:
type:
- string
- 'null'
description: Prevedere Classification for indicator
seasonalAdjustment:
type:
- string
- 'null'
description: Identifies if indicator is seasonally adjusted
periodAlignment:
type:
- string
- 'null'
description: Identifies if time series aligns with the beginning or end of time period
interval:
type:
- string
- 'null'
description: Name and multiple used to describe period length of indicator the time series, similar to frequency
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RequestPoint'
description: Data Time Series For Indicator
calculation:
type:
- string
- 'null'
projectId:
type:
- string
- 'null'
description: Optional Project ID to associate the indicator with a specific project
additionalProperties: false
AggregationMethod:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
type: integer
format: int32
Classification:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
type: integer
format: int32
CompositeMetadata:
type: object
properties:
provider:
type:
- string
- 'null'
description: Unique identifier for provider
providerId:
type:
- string
- 'null'
description: Indicator Identifier
name:
type:
- string
- 'null'
description: Indicator Name
description:
type:
- string
- 'null'
description: Indicator Description
notes:
type:
- string
- 'null'
description: Indicator Notes
units:
type:
- string
- 'null'
description: Indicator Units of measurement
citation:
type:
- string
- 'null'
description: Indicator Citation
path:
type:
- string
- 'null'
description: Path of indicator in Prevedere folder structure
color:
type:
- string
- 'null'
description: Color code to be used in the Prevedere application
aggregation:
type:
- string
- 'null'
description: Aggregation method used for indicator time series
tags:
type:
- array
- 'null'
items:
type: string
description: Tags assigned to help organize indicator
industryCodes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/IndustryCode'
description: Industry codes assigned to indicator
classification:
type:
- string
- 'null'
description: Classification for indicator
seasonalAdjustment:
type:
- string
- 'null'
description: Identifies if indicator is seasonally adjusted
periodAlignment:
type:
- string
- 'null'
description: Identifies if time series aligns with the beginning or end of time period
interval:
type:
- string
- 'null'
description: Name and multiple used to describe period length of indicator time series, similar to frequency
frequency:
type:
- string
- 'null'
description: Frequency of indicator time series
calculation:
type:
- string
- 'null'
description: Calculation of composite indicator
additionalProperties: false
description: This schema contains the metadata for the composite indicator
CompositeIndicatorEntry:
type: object
properties:
provider:
type:
- string
- 'null'
description: Unique Identifier for Provider.
providerId:
type:
- string
- 'null'
description: Identifier for indicator
offset:
type: integer
description: Offset applied to indicator
format: int32
calculation:
type:
- string
- 'null'
description: Calculation of indicator
variableName:
type:
- string
- 'null'
description: Variable name for indicator that is reference in the formula
additionalProperties: false
Seasonality:
enum:
- 0
- 1
- 999
type: integer
format: int32
Correlation:
type: object
properties:
counterCyclic:
type: number
format: double
periodShift:
type: integer
format: int32
proCyclic:
type: number
format: double
correlationCoefficient:
type: number
format: double
rSquared:
type: number
format: double
numberOfDataPoints:
type: integer
format: int32
notes:
type:
- string
- 'null'
additionalProperties: false
PeriodAlignment:
enum:
- 0
- 1
- 2
type: integer
format: int32
RequestPoint:
type: object
properties:
value:
type: number
format: double
annotation:
type:
- string
- 'null'
date:
type: string
format: date-time
isForecasted:
type: boolean
additionalProperties: false
CompositeDefinition:
type: object
properties:
entries:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CompositeIndicatorEntry'
description: A list of indicators used in the composite formula.
formula:
type:
- string
- 'null'
description: Formula for composite Indicator
startDate:
type:
- string
- 'null'
description: Start Date of Composite Indicator
format: date-time
compositeMetadata:
$ref: '#/components/schemas/CompositeMetadata'
additionalProperties: false
description: This schema contains the definition of a composite indicator. It includes the formula, start date and information for each indicator used in the formula.
CorrelationSet:
type: object
properties:
calculation:
$ref: '#/components/schemas/Calculation'
maxDataPointOverlap:
type: integer
format: int32
minDataPointOverlap:
type: integer
format: int32
bestCorrelationCoefficient:
type: number
format: double
bestRSquared:
type: number
format: double
bestProcyclic:
type: number
format: double
bestCountercyclic:
type: number
format: double
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Correlation'
additionalProperties: false
CompositeDefinitionCreateRequest:
type: object
properties:
entries:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CompositeEntryUpdateRequest'
description: Indicator Entries that are used in the composite formula
formula:
type:
- string
- 'null'
description: Formula for composite Indicator where each variable represents a CompositeIndicatorEntry
startDate:
type:
- string
- 'null'
description: Optional Start Date of Composite, when blank the series will start on the first common date across variables
format: date-time
compositeMetadata:
$ref: '#/components/schemas/CompositeMetadataCreateRequest'
additionalProperties: false
description: Request used to create a composite indicator
ProviderAccess:
enum:
- 0
- 1
- 2
type: integer
format: int32
Calculation:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
description: 'The transformation applied to the data.
Possible options:
None 1
PeriodOverPeriod 2
YearOverYear 3
ThreePeriodYearOverYear 6'
format: int32
Point:
type: object
properties:
value:
type: number
format: double
date:
type: string
format: date-time
annotation:
type:
- string
- 'null'
manuallyAdjusted:
type: boolean
isForecasted:
type:
- boolean
- 'null'
additionalProperties: false
CompositeMetadataCreateRequest:
type: object
properties:
provider:
type:
- string
- 'null'
description: Unique identifier for provider
providerId:
type:
- string
- 'null'
description: Indicator Identifier
name:
type:
- string
- 'null'
description: Indicator Name
description:
type:
- string
- 'null'
description: Indicator Description
notes:
type:
- string
- 'null'
description: Indicator Notes
units:
type:
- string
- 'null'
description: Indicator Units of measurement
citation:
type:
- string
- 'null'
description: Indicator Citation
path:
type:
- string
- 'null'
description: Path of indicator in Prevedere folder structure
color:
type:
- string
- 'null'
description: Color code to be used in the Prevedere application
aggregation:
type:
- string
- 'null'
description: Aggregation method used for indicator time series
tags:
type:
- array
- 'null'
items:
type: string
description: Tags assigned to help organize indicator
industryCodes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/IndustryCode'
description: Industry codes assigned to indicator
classification:
type:
- string
- 'null'
description: Prevedere Classification for indicator
seasonalAdjustment:
type:
- string
- 'null'
description: Identifies if indicator is seasonally adjusted
periodAlignment:
type:
- string
- 'null'
description: Identifies if time series aligns with the beginning or end of time period
interval:
type:
- string
- 'null'
description: Name and multiple used to describe period length of indicator the time series, similar to frequency
frequency:
type:
- string
- 'null'
description: Frequency of indicator time series
calculation:
type:
- string
- 'null'
description: Calculation of composite indicator
projectId:
type:
- string
- 'null'
description: Optional Project ID to associate the indicator with a specific project
additionalProperties: false
CompositeDefinitionUpdateRequest:
type: object
properties:
entries:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CompositeEntryUpdateRequest'
description: Indicator Entries that are used in the composite formula
formula:
type:
- string
- 'null'
description: Formula for composite Indicator where each variable represents a CompositeIndicatorEntry
startDate:
type:
- string
- 'null'
description: Optional Start Date of Composite, when blank the series will start on the first common date across variables
format: date-time
compositeMetadata:
$ref: '#/components/schemas/BaseIndicatorMetadataWithFrequencyRequest'
additionalProperties: false
description: Request used to update the formula of an existing composite indicator, the mix of indicators used as variables in the composite formula, or metadata about the composite indicator.
IndicatorDataSource:
type: object
properties:
name:
type:
- string
- 'null'
url:
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prevedere/refs/heads/main/openapi/prevedere-indicator-api-openapi.yml