Quartr API PortalGuideReference
v1.0.0
OAS 3.0.0

@quartr-app/api-public

The reference provides a detailed explanation of all resources accessible through the Quartr API. Our API is designed around REST, has predictable resource-oriented URLs and uses standard HTTP verbs and status codes.

Client Libraries
Curl Shell

Events

​
Events Operations

/public/v1/companies/ticker/earlier-events

​

Retrieves the latest events for a specific set of tickers (Min: 1, Max: 100 ).

Query Parameters
  • limit
    Type:number Format: double
    default: 
    10

    The maximum number of events to retrieve (Max: 500).

  • page
    Type:number Format: double
    default: 
    1

    The page number for event search.

Body
application/json

The search parameters.

  • tickers
    Type:array
    required

    Tickers to retrieve the latest events for

    Any of
    • Type:string
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example forPOST/public/v1/companies/ticker/earlier-events
curl https://api.quartr.com/public/v1/companies/ticker/earlier-events \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "tickers": [
    ""
  ]
}'

{
  "pagination": {
    "limit": 1,
    "totalPages": 1,
    "page": 1,
    "total": 1
  },
  "data": [
    {
      "liveTranscripts": {
        "finishedLiveTranscriptUrl": "…",
        "liveTranscriptUrl": "…"
      },
      "transcripts": {
        "transcriptUrl": "…"
      },
      "transcriptUrl": "…",
      "liveState": {
        "liveAudioState": "live",
        "liveUrl": "https://files.quartr.com/42523/playlists.m3u8",
        "wentLiveAt": "2020-01-01T00:00:00.000Z"
      },
      "backlinkUrl": "…",
      "isins": null,
      "ticker": null,
      "companyId": null,
      "slidesPreviewUrl": "…",
      "audioDuration": null,
      "eventType": {
        "secondaryType": null,
        "type": null
      },
      "fiscalYear": null,
      "fiscalPeriod": null,
      "qnaTimestamp": null,
      "eventDate": null,
      "eventTitle": null,
      "eventId": null,
      "pdfUrl": null,
      "reportUrl": null,
      "audioUrl": null
    }
  ]
}

A promise that resolves to an array of company and event data.

Documents (Collapsed)

​
Documents Operations

Document Types (Collapsed)

​
Document Types Operations

Models