stats_can.schemas
Objects representing what's returned from the Statistics Canada Web Data Service.
Having these created allows pydantic validation without doing crazy long type signatures. It should also help your editor pick up on what attributes are available, and its useful for referencing things in the docs.
ChangedSeries
Bases: TypedDict
responseStatusCode: int
instance-attribute
vectorId: int
instance-attribute
productId: int
instance-attribute
coordinate: str
instance-attribute
releaseTime: str
instance-attribute
ChangedCube
Bases: TypedDict
responseStatusCode: int
instance-attribute
productId: int
instance-attribute
releaseTime: str
instance-attribute
Member
Bases: TypedDict
memberId: int
instance-attribute
parentMemberId: int | None
instance-attribute
memberNameEn: str
instance-attribute
memberNameFr: str
instance-attribute
classificationCode: str | None
instance-attribute
classificationTypeCode: str | None
instance-attribute
geoLevel: int | None
instance-attribute
vintage: int | None
instance-attribute
terminated: int
instance-attribute
memberUomCode: int | None
instance-attribute
Dimension
Bases: TypedDict
dimensionPositionId: int
instance-attribute
dimensionNameEn: str
instance-attribute
dimensionNameFr: str
instance-attribute
hasUom: bool
instance-attribute
member: list[Member]
instance-attribute
FootNoteLink
Bases: TypedDict
footnoteId: int
instance-attribute
dimensionPositionId: int
instance-attribute
memberId: int
instance-attribute
Footnote
Bases: TypedDict
footnoteId: int
instance-attribute
footnotesEn: str
instance-attribute
footnotesFr: str
instance-attribute
link: FootNoteLink
instance-attribute
CubeMetadata
Bases: TypedDict
responseStatusCode: int
instance-attribute
productId: int
instance-attribute
cansimId: str | None
instance-attribute
cubeTitleEn: str
instance-attribute
cubeTitleFr: str
instance-attribute
cubeStartDate: str | None
instance-attribute
cubeEndDate: str | None
instance-attribute
frequencyCode: int
instance-attribute
nbSeriesCube: int
instance-attribute
nbDatapointsCube: int
instance-attribute
releaseTime: str | None
instance-attribute
archiveStatusCode: str
instance-attribute
archiveStatusEn: str
instance-attribute
archiveStatusFr: str
instance-attribute
subjectCode: list[str]
instance-attribute
surveyCode: list[str]
instance-attribute
dimension: list[Dimension]
instance-attribute
footnote: list[Footnote]
instance-attribute
correction: list[Any]
instance-attribute
correctionFootnote: list[Any]
instance-attribute
issueDate: str | None
instance-attribute
SeriesInfo
Bases: TypedDict
responseStatusCode: int
instance-attribute
productId: int
instance-attribute
coordinate: str
instance-attribute
vectorId: int
instance-attribute
frequencyCode: int
instance-attribute
scalarFactorCode: int
instance-attribute
decimals: int
instance-attribute
terminated: int
instance-attribute
SeriesTitleEn: str
instance-attribute
SeriesTitleFr: str
instance-attribute
memberUomCode: int
instance-attribute
VectorDataPoint
Bases: TypedDict
refPer: str
instance-attribute
refPer2: str
instance-attribute
refPerRaw: str
instance-attribute
refPerRaw2: str
instance-attribute
value: str | int | float
instance-attribute
decimals: int
instance-attribute
scalarFactorCode: int
instance-attribute
symbolCode: int
instance-attribute
statusCode: int
instance-attribute
securityLevelCode: int
instance-attribute
releaseTime: str
instance-attribute
frequencyCode: int
instance-attribute
VectorData
Bases: TypedDict
responseStatusCode: int
instance-attribute
productId: int
instance-attribute
coordinate: str
instance-attribute
vectorId: int
instance-attribute
vectorDataPoint: list[VectorDataPoint]
instance-attribute
ScalarFactor
Bases: TypedDict
scalarFactorCode: int
instance-attribute
scalarFactorDescEn: str
instance-attribute
scalarFactorDescFr: str
instance-attribute
FrequencyCode
Bases: TypedDict
frequencyCode: int
instance-attribute
frequencyDescEn: str
instance-attribute
frequencyDescFr: str
instance-attribute
SymbolCode
Bases: TypedDict
symbolCode: int
instance-attribute
symbolDescEn: str
instance-attribute
symbolDescFr: str
instance-attribute
StatusCode
Bases: TypedDict
statusCode: int
instance-attribute
statusDescEn: str
instance-attribute
statusDescFr: str
instance-attribute
UomCode
Bases: TypedDict
memberUomCode: int
instance-attribute
memberUomEn: str | None
instance-attribute
memberUomFr: str | None
instance-attribute
SurveyCode
Bases: TypedDict
surveyCode: int
instance-attribute
surveyEn: str | None
instance-attribute
surveyFr: str | None
instance-attribute
SubjectCode
Bases: TypedDict
subjectCode: int
instance-attribute
subjectEn: str | None
instance-attribute
subjectFr: str | None
instance-attribute
ClassificationTypeCode
Bases: TypedDict
classificationTypeCode: int
instance-attribute
classificationTypeEn: str | None
instance-attribute
classificationTypeFr: str | None
instance-attribute
SecurityLevelCode
Bases: TypedDict
securityLevelCode: int
instance-attribute
securityLevelRepresentationEn: str | None
instance-attribute
securityLevelRepresentationFr: str | None
instance-attribute
securityLevelDescEn: str
instance-attribute
securityLevelDescFr: str
instance-attribute
CodeCode
Bases: TypedDict
codeId: int
instance-attribute
codeTextEn: str
instance-attribute
codeTextFr: str
instance-attribute
CodeSet
Bases: TypedDict