Response Types

SingStat custom types for client methods’ responses.

Common Types

class singstat.client.types._DataDict

Bases: TypedDict

Type definition for various custom types

generatedBy: str

Generated by

dateGenerated: date

Date generated

class singstat.client.types._RecordDict

Bases: TypedDict

Type definition for various custom types

theme: NotRequired[str]

Theme

subject: NotRequired[str]

Subject

topic: NotRequired[str]

Topic

id: NotRequired[str]

ID

title: NotRequired[str]

Title

frequency: NotRequired[str]

Frequency

footnote: NotRequired[str]

Footnote

dataLastUpdated: NotRequired[date]

Data last updated

class singstat.client.types._SingStatDict

Bases: TypedDict

Type definition for various custom types

DataCount: int

Data count

StatusCode: int

Status code

Message: str

Message

resource_id()

class singstat.client.types.ResourceIdDict

Bases: _SingStatDict

Type definition for resource_id()

Data: _ResourceIdDataDict

Data

class singstat.client.types._ResourceIdDataDict

Bases: _DataDict

Type definition for ResourceIdDict

total: int

Total

records: list[_ResourceIdDataRecordDict]

Records

class singstat.client.types._ResourceIdDataRecordDict

Bases: _RecordDict

Type definition for _ResourceIdDataDict

tableType: str

Table type

metadata()

class singstat.client.types.MetadataDict

Bases: _SingStatDict

Type definition for metadata()

Data: _MetadataDataDict

Data

class singstat.client.types._MetadataDataDict

Bases: _DataDict

Type definition for MetadataDict

records: _MetadataDataRecordsTimeseriesDict | _MetadataDataRecordsCrossSectionalMultiDimensionalCubeDict

Records

class singstat.client.types._MetadataDataRecordsTimeseriesDict

Bases: _MetadataDataRecordsDict

Type definition for _MetadataDataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

startPeriod: NotRequired[str]

Start period

endPeriod: NotRequired[str]

End period

total: NotRequired[int]

Total

row: NotRequired[list[_MetadataDataRecordsTimeseriesRowDict]]

Row

class singstat.client.types._MetadataDataRecordsTimeseriesRowDict

Bases: _MetadataDataRecordsRowDict

Type definition for _MetadataDataRecordsDict

seriesNo: str

Series number

class singstat.client.types._MetadataDataRecordsCrossSectionalMultiDimensionalCubeDict

Bases: _MetadataDataRecordsDict

Type definition for _MetadataDataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

tableType: NotRequired[str]

Table type

column1: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 1

column2: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 2

column3: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 3

column4: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 4

column5: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 5

column6: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 6

column7: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 7

column8: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 8

column9: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 9

column10: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict]]

Column 10

row: NotRequired[list[_MetadataDataRecordsCrossSectionalMultiDimensionalCubeRowDict]]

Row

class singstat.client.types._MetadataDataRecordsCrossSectionalMultiDimensionalCubeColumnDict

Bases: TypedDict

Type definition for _MetadataDataRecordsCrossSectionalMultiDimensionalCubeDict

columnNo: str

Column number

columnText: str

Column text

footnote: str

Footnote

class singstat.client.types._MetadataDataRecordsCrossSectionalMultiDimensionalCubeRowDict

Bases: _MetadataDataRecordsRowDict

Type definition for _MetadataDataRecordsDict

rowNo: str

Row number

class singstat.client.types._MetadataDataRecordsDict

Bases: _RecordDict

Type definition for _MetadataDataRecordsTimeseriesDict and _MetadataDataRecordsCrossSectionalMultiDimensionalCubeDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

dataSource: NotRequired[str]

Data source

class singstat.client.types._MetadataDataRecordsRowDict

Bases: TypedDict

Type definition for _MetadataDataRecordsTimeseriesRowDict and _MetadataDataRecordsCrossSectionalMultiDimensionalCubeRowDict

rowText: str

Row text

uoM: str

Unit of measurement

footnote: str

Footnote

tabledata()

class singstat.client.types.TabledataDict

Bases: _SingStatDict

Type definition for tabledata()

Data: _TabledataDataTimeseriesDict | _TabledataDataCrossSectionalMultiDimensionalCubeDict

Data

class singstat.client.types._TabledataDataTimeseriesDict

Bases: _TabledataDataDict

Type definition for _TabledataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

datasource: NotRequired[str]

Data source

sortBy: NotRequired[str | None]

Sort by

timeFilter: NotRequired[str | None]

Time filter

row: NotRequired[list[_TabledataDataTimeseriesRowDict]]

Row

class singstat.client.types._TabledataDataTimeseriesRowDict

Bases: _TabledataDataRowDict

Type definition for _TabledataDataTimeseriesDict

seriesNo: str

Series number

columns: list[_TabledataDataRowColumnDict]

Columns

class singstat.client.types._TabledataDataCrossSectionalMultiDimensionalCubeDict

Bases: _TabledataDataDict

Type definition for TabledataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

tableType: NotRequired[str]

Table type

dataSource: NotRequired[str]

Data source

row: NotRequired[list[_TabledataDataCrossSectionalMultiDimensionalCubeRowDict]]

Row

class singstat.client.types._TabledataDataCrossSectionalMultiDimensionalCubeRowDict

Bases: _TabledataDataRowDict

Type definition for _TabledataDataCrossSectionalMultiDimensionalCubeDict

rowNo: str

Row number

columns: list[_TabledataDataRowColumnDict | _TabledataDataRowColumnColumnDict]

Columns

class singstat.client.types._TabledataDataRowColumnColumnDict

Bases: TypedDict

Type definition for _TabledataDataCrossSectionalMultiDimensionalCubeRowDict

key: str

Key

columns: list[_TabledataDataRowColumnColumnDict | _TabledataDataRowColumnDict]

Columns

class singstat.client.types._TabledataDataRowColumnDict

Bases: TypedDict

Type definition for _TabledataDataRowColumnColumnDict, _TabledataDataTimeseriesRowDict, and _TabledataDataCrossSectionalMultiDimensionalCubeRowDict

key: str

Key

value: NotRequired[Any]

Value

class singstat.client.types._TabledataDataDict

Bases: _DataDict, _RecordDict

Type definition for _TabledataDataTimeseriesDict and _TabledataDataCrossSectionalMultiDimensionalCubeDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

offset: NotRequired[int | None]

Offset

limit: NotRequired[int]

Limit

between: NotRequired[tuple[int, ...] | None]

Between

search: NotRequired[str | None]

Search

class singstat.client.types._TabledataDataRowDict

Bases: TypedDict

Type definition for _TabledataDataTimeseriesRowDict and _TabledataDataCrossSectionalMultiDimensionalCubeRowDict

rowText: str

Row text

uoM: str

Unit of measurement

footnote: str

Footnote