Alpha AnalystDocs
API Portal

User Documents API

Search files you or your organization uploaded — PDF, Office, images, markdown — then look up one file and read its text.

User Documents is your library: files you or your organization uploaded to Alpha Analyst, not SEC or EDINET.

Platform-linked Uploaded files for the login behind your key—same as on the website. That login needs an API plan and Files on its website plan; the key is enough. How platform-linked access works.

Never send user_id or organization_id. Identity is bound from your credentials. If you belong to an organization, listings include files and folders owned by you or that organization.

Do not send user_id

Identity is bound from your API key or OAuth token. Asking sources=user while anonymous is 401.

Browse or name-search with User Files. Keyword-search bodies with User Document Search. Then pass document_id to User Document Reference or User Documents Markdown.

Search hits are Document items with kind=document (an upload has no parent): document_id, source=user, published_at as upload time (UTC), filing_id null, plus upload fields. Folder and file-type filters live here. Public filings stay on Documents.

Coverage

  • Whose files. Yours, and your organization’s when you are in one. There is no public user-document corpus.
  • When. From each file’s upload time (published_at, also returned as filed_at). See published_at.
  • Which types. Stored types include PDF, Word, PowerPoint, Excel, CSV, plain text, markdown, and common images (pdf, docx, pptx, xlsx, csv, txt, md, png, jpeg, …). Call User Document Types for the list. Leading dots on filters are optional (pdf or .pdf).
  • What you read. Search and Markdown use the extracted text we stored. Images are flagged with is_image; they are not a second filing corpus.

Extra fields

On top of The Document item:

FieldRole
file_typeStored type (pdf, docx). Leading dots are optional on filters.
parent_folder_idFolder id. Omitted for files in the root folder
is_imageTrue when the upload is stored as an image

Filters

file_types matches the stored type. parent_folder_ids lists folder ids; pass main for files with no parent (the root folder). from_date / to_date filter upload day.

Files and folders

User Files is one endpoint for browse and name search.

  • Omit query to list one folder. parent_folder_id defaults to main (the library root). Results are one level: folders first (by name), then files (newest first). Not a nested tree.
  • Pass query to match file and folder names. Omit parent_folder_id to search the whole library; set it to search only that folder (not nested children).
  • Optional kind is file or folder.
  • Folders use folder_id. Files use document_id — pass that to Reference or Markdown as id. Never id.
  • Each item includes path from main to its parent. truncated is true when the page cap was hit.

Empty values are omitted.

Documents Overview

One list across SEC, EDINET, and uploads.

Entities

Resolve a company before you scope a filing search.

On this page

CoverageExtra fieldsFiltersFiles and foldersRelated