Endpoint reference

First-party account flow · follow the website instructions

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

SignupRequest

{
  "$ref": "#/components/schemas/SignupRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/EmailVerificationPendingResponse"
    },
    {
      "$ref": "#/components/schemas/AuthSessionResponse"
    }
  ]
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

First-party browser flow. Accepts the signed handoffTicket returned by signup, valid for 30 minutes. It is not an email-verification token or login credential. Returns only verification state for that signup; never grants a session. The response is no-store. Limit is 240 checks per ticket per 20 minutes, plus general request safeguards.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

SignupHandoffRequest

{
  "$ref": "#/components/schemas/SignupHandoffRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "verified"
      ],
      "properties": {
        "verified": {
          "type": "boolean"
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/ApiMeta"
    }
  }
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

Requires the unexpired signup handoff ticket, completed email verification and the account password. The ticket alone never signs a user in. MFA, account/workspace checks and login rate limits still apply. Production issues a Secure HttpOnly browser cookie, never a raw session credential. The default 12-hour session applies; rememberMe is not an input to this operation. Use the first-party website; this is not an API-key authentication endpoint. No new Turnstile token is required because the ticket was issued after the protected signup request.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "type": "object",
  "required": [
    "ticket",
    "password"
  ],
  "properties": {
    "ticket": {
      "$ref": "#/components/schemas/SignupHandoffTicket"
    },
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    }
  }
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/AuthSessionResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

LoginRequest

{
  "$ref": "#/components/schemas/LoginRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/AuthSessionResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

AccountActionTokenRequest

{
  "$ref": "#/components/schemas/AccountActionTokenRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/GenericResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

EmailActionRequest

{
  "$ref": "#/components/schemas/EmailActionRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/AccountActionAcceptedResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

EmailActionRequest

{
  "$ref": "#/components/schemas/EmailActionRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/AccountActionAcceptedResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

PasswordResetConfirmRequest

{
  "$ref": "#/components/schemas/PasswordResetConfirmRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

First-party account flow · follow the website instructions

No path or query parameters are specified for this operation.

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

No path or query parameters are specified for this operation.

Replace YOUR_… with identifiers from your available records. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --get 'https://api.filingsift.com/api/v1/account/monitoring' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/MonitoringOverviewResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Owner or admin role required. Issuer filters must belong to the organization watchlist.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

MonitoringPreferenceRequest

{
  "$ref": "#/components/schemas/MonitoringPreferenceRequest"
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request PATCH 'https://api.filingsift.com/api/v1/account/monitoring/preferences' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

{
  "$ref": "#/components/schemas/MonitoringPreferenceResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Parameters

Replace YOUR_… with identifiers from your available records. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --get 'https://api.filingsift.com/api/v1/account/monitoring/deliveries' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/MonitoringDeliveryListResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Owner or admin role required. Limited to three test deliveries per user per hour.

No path or query parameters are specified for this operation.

Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/account/monitoring/test' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/MonitoringDeliveryResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Parameters

Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/account/monitoring/deliveries/YOUR_DELIVERYID/retry' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/MonitoringDeliveryResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Parameters

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ReaderAnnotationListResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Browser session required. The server copies the exact passage and hash; callers cannot submit evidence text.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

ReaderAnnotationRequest

{
  "$ref": "#/components/schemas/ReaderAnnotationRequest"
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ReaderAnnotationResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Parameters

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

No path or query parameters are specified for this operation.

Replace YOUR_… with identifiers from your available records. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --get 'https://api.filingsift.com/api/v1/account' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/AccountResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Browser session only. Active subscriptions must be cancelled first; protected platform administrators must transfer administration. Account deletion revokes credentials and cleans up private account data transactionally.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "currentPassword",
    "confirmation"
  ],
  "properties": {
    "currentPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "confirmation": {
      "type": "string",
      "const": "DELETE"
    }
  }
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Browser session only. The name is shown in team member and review-assignment views; email, role, and entitlements are unchanged.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "displayName"
  ],
  "properties": {
    "displayName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    }
  }
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/GenericResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email",
    "currentPassword"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 254
    },
    "currentPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    }
  }
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/GenericResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "currentPassword",
    "password"
  ],
  "properties": {
    "currentPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "password": {
      "type": "string",
      "minLength": 12,
      "maxLength": 128,
      "writeOnly": true
    }
  }
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

No path or query parameters are specified for this operation.

Replace YOUR_… with identifiers from your available records. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --get 'https://api.filingsift.com/api/v1/account/audit' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/AuditResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

ApiKeyCreateRequest

{
  "$ref": "#/components/schemas/ApiKeyCreateRequest"
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/account/api-keys' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

{
  "$ref": "#/components/schemas/ApiKeyIssueResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Parameters

Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/account/api-keys/YOUR_KEY_ID/rotate' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/ApiKeyIssueResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Parameters

Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request DELETE 'https://api.filingsift.com/api/v1/account/api-keys/YOUR_KEY_ID' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/ApiKeyResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

All plans return indexed_existing immediately for an existing non-illustrative filing belonging to the resolved SEC issuer. Missing coverage queues a shared asynchronous request for up to 25 supported filings and two SEC historical-submission files within plan lookback and pending/company limits. Unknown SEC tickers return 422; no complete historical coverage or completion time is guaranteed.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "ticker": {
      "type": "string",
      "pattern": "^[A-Za-z0-9.-]{1,16}$"
    }
  }
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/account/companies' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

{
  "$ref": "#/components/schemas/TickerResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

All plans may request bounded asynchronous retrieval for an already configured company. Repeated active requests share the same issuer queue. Company authorization, pending-request limits and processing lookback remain enforced.

Parameters

Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/account/companies/YOUR_TICKER/onboarding' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/TickerResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Parameters

Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request DELETE 'https://api.filingsift.com/api/v1/account/companies/YOUR_TICKER' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Parameters

Request body (required)

Content type: application/json

{
  "type": "object",
  "required": [
    "role"
  ],
  "properties": {
    "role": {
      "$ref": "#/components/schemas/MembershipRole"
    }
  }
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request PATCH 'https://api.filingsift.com/api/v1/account/members/YOUR_USER_ID' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

{
  "$ref": "#/components/schemas/MembershipResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

Parameters

Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request DELETE 'https://api.filingsift.com/api/v1/account/members/YOUR_USER_ID' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY"

Responses

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

No API key required; supplied credentials can add restrictions

No path or query parameters are specified for this operation.

Replace YOUR_… with identifiers from your available records. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --get 'https://api.filingsift.com/api/v1/analyst/vocabulary'

Responses

{
  "$ref": "#/components/schemas/GenericResponse"
}

Link to this operation · Download the contract

API key or signed-in session

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

AnalystExportRequest

{
  "$ref": "#/components/schemas/AnalystExportRequest"
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/analyst/tables/financing' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

{
  "$ref": "#/components/schemas/GenericResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

AnalystExportRequest

{
  "$ref": "#/components/schemas/AnalystExportRequest"
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/analyst/exports/xlsx' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

{
  "type": "string",
  "format": "binary"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

API key or signed-in session

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

AnalystExportRequest

{
  "$ref": "#/components/schemas/AnalystExportRequest"
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/analyst/exports/xlsx/manifest' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

{
  "$ref": "#/components/schemas/GenericResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

No API key required; supplied credentials can add restrictions

No path or query parameters are specified for this operation.

Replace YOUR_… with identifiers from your available records. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --get 'https://api.filingsift.com/api/v1/analyst/modeling/vocabulary'

Responses

Link to this operation · Download the contract

API key or signed-in session

Required scopes: exports:read. Account, role and source checks still apply.

Deployed migration 027 route requiring exports:read, billing access and issuer and indexed-history access; accepts at most 500 uniquely identified formulas expanding to at most 1000 data cells. Comparability-aware comparability review makes latest select a period end rather than a filing vintage. Competing scope, value or unresolved metadata returns null with alternatives/review; a singleton with blocking metadata is unavailable. Available scalars disclose only_matching_observation or equivalent_observations_with_representative_source selection. Capped candidate scans and unsafe numeric conversions do not select a value.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/AnalystModelDefinition"
    },
    {
      "$ref": "#/components/schemas/AnalystScalarFormula"
    },
    {
      "$ref": "#/components/schemas/AnalystTableFormula"
    }
  ]
}

Request example:

{
  "formulas": [
    {
      "id": "cash",
      "function": "VALUE",
      "ticker": "AAPL",
      "concept": "cash_and_cash_equivalents",
      "period": "latest"
    }
  ]
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/analyst/formulas/resolve' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

Link to this operation · Download the contract

API key or signed-in session

Required scopes: exports:read. Account, role and source checks still apply.

Deployed migration 027 route requiring exports:read, billing access, and issuer and indexed-history access. TABLE cells use the same comparability-aware scalar policy as formula resolution; available cells retain source context and verification metadata, while unresolved alternatives remain null with review details.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "function": {
      "type": "string",
      "const": "TABLE"
    },
    "template": {
      "type": "string",
      "enum": [
        "historical_statements",
        "comparable_companies"
      ],
      "default": "historical_statements"
    },
    "ticker": {
      "type": "string"
    },
    "tickers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 25
    },
    "concepts": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 25
    },
    "period": {
      "type": "string"
    },
    "periods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 40
    }
  },
  "anyOf": [
    {
      "required": [
        "ticker"
      ]
    },
    {
      "required": [
        "tickers"
      ]
    }
  ]
}

Request example:

{
  "template": "historical_statements",
  "tickers": [
    "AAPL"
  ],
  "concepts": [
    "cash_and_cash_equivalents"
  ],
  "periods": [
    "latest"
  ]
}

Create request.json using the request fields below. Replace YOUR_… with identifiers from your available records. Check the operation description before sending: writes can change your workspace or trigger delivery. This is a request template, not a prefilled production transaction.

curl --fail-with-body --show-error --request POST 'https://api.filingsift.com/api/v1/analyst/templates/render' \
  -H "Authorization: Bearer $FILINGSIFT_API_KEY" \
  -H 'Content-Type: application/json' \
  --data @request.json

Responses

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Requires a browser session, account:read, exports:read, and billing access. API keys are rejected.

No path or query parameters are specified for this operation.

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Requires a browser session, account:read, exports:read, and billing access. API keys are rejected.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "name",
        "definition"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "definition": {
          "$ref": "#/components/schemas/AnalystModelDefinition"
        }
      }
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnalystModelDefinition"
        },
        {
          "type": "object",
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            }
          }
        }
      ]
    }
  ]
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Requires the owner's browser session, account:read, exports:read, and billing access; issuer and indexed-history access are rechecked for current and prior provenance. New v2 manifests retain complete before/after cells, formulas and observed differences without causal inference. Appends compare the latest saved snapshot atomically and never silently evict history. API keys are rejected. The deployed route reuses migration 027.

Parameters

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Requires the owner's browser session, account:read, exports:read, billing access, and current issuer and indexed-history access to the entire saved provenance chain including old sources and alternatives. Returns at most 100 stored refreshes without rebuilding. Missing legacy metadata fails closed. Global response-size limits apply. API keys are rejected.

Parameters

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Deployed route reusing migration 027. Requires the owner's browser session, account:read, exports:read, billing, and current issuer and indexed-history access to the entire saved history and retained before/after provenance, before cell filtering. Selects newest matching refreshes and returns them chronologically. Does not read current filings or regenerate explanations. Legacy explanations are unavailable; insufficient saved scope/date metadata refuses the whole read. Changes describe observations, not issuer restatements or causal conclusions. Manifest counts remain complete even for a cell-filtered review. Only limit and cell_id are accepted.

Parameters

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ModelRefreshReviewResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Requires a browser session, account:read, and workspace:write. The worker rechecks current billing and issuer and indexed-history access when executing a refresh.

Parameters

Request body (required)

Content type: application/json

{
  "type": "object",
  "properties": {
    "frequency": {
      "type": "string",
      "enum": [
        "hourly",
        "daily",
        "weekly"
      ],
      "default": "daily"
    },
    "enabled": {
      "type": "boolean",
      "default": true
    },
    "destinationIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "minItems": 0,
      "maxItems": 10
    }
  }
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Deployed migration 029 workflow with bounded base preview/save/reopen and access-change acceptance. Requires a browser session, account:read, exports:read, billing access, and current issuer and indexed-history access. API keys and all query parameters are rejected. No arbitrary backdated or search/XBRL replay is supported. Captures at most 40 filings and 400 documents; selected input JSON is capped at 12000000 bytes and the artifact at 1500000 bytes. Unsupported nested result fields and incomplete/corrupt included evidence refuse capture without silent dropping. Filing-timeline and broader customer-workflow acceptance remain separate.

No path or query parameters are specified for this operation.

Request body (required)

Content type: application/json

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ResearchSnapshotDefinition"
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "definition"
      ],
      "properties": {
        "definition": {
          "$ref": "#/components/schemas/ResearchSnapshotDefinition"
        },
        "sourceReport": {
          "type": "object",
          "additionalProperties": true,
          "description": "Signed source report required for source_research_report"
        }
      }
    }
  ]
}

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses

{
  "$ref": "#/components/schemas/ResearchSnapshotPreviewResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

{
  "$ref": "#/components/schemas/ErrorResponse"
}

Link to this operation · Download the contract

Signed-in website session · API keys are not accepted

Requires a browser session, account:read, exports:read, and billing access. Does not recheck issuer and indexed-history access for summary metadata; full-result reopening does. Returns no other user's artifact metadata. No query parameters or pagination; organization storage is capped at 100 artifacts.

No path or query parameters are specified for this operation.

Use the signed-in workspace or authorized provider/admin workflow described above. This operation is not a general API-key quickstart.

Responses