@leopiccionia/numista-sdk / Exports / TypeUpdate
Interface: TypeUpdate
Table of contents
Properties
- calendar
- category
- commemorated_topic
- comments
- composition
- demonetization
- edge
- issuer
- mints
- obverse
- orientation
- printers
- references
- related_coins
- reverse
- ruling_authority
- series
- shape
- size
- tags
- technique
- thickness
- title
- type
- value
- watermark
- weight
Properties
calendar
• Optional calendar: Object
Calendar to which the year visible on the type belongs
Type declaration
| Name | Type | Description |
|---|---|---|
code |
string |
Unique ID of the calendar on Numista |
category
• category: Category
Category
commemorated_topic
• Optional commemorated_topic: LocalizedLabel[]
For commemorated types, short description of the commemorated topic (event, person, etc.)
comments
• Optional comments: LocalizedLabel[]
General comments about the type (HTML format)
composition
• Optional composition: Object
Composition (metallic content)
Type declaration
| Name | Type | Description |
|---|---|---|
additional_details? |
LocalizedLabel[] |
- |
composition_type |
"plain" |
Type of composition |
core? |
{ fineness?: number ; material: { id: number } } |
COmposition of the core |
core.fineness? |
number |
Fineness of the material (e.g. 999.9) |
core.material |
{ id: number } |
- |
core.material.id |
number |
Unique ID of the material on Numista |
demonetization
• Optional demonetization: Object
Inform whether the coin or banknote is demonetized
Type declaration
| Name | Type | Description |
|---|---|---|
demonetization_date? |
string |
Demonetization date, with format “YYYY-MM-DD” |
is_demonetized |
boolean |
true for demonetized, and false if still legal tender |
edge
• Optional edge: TypeSideUpdate
issuer
• Optional issuer: Object
Issuer
Type declaration
| Name | Type | Description |
|---|---|---|
code |
string |
Unique ID of the issuer on Numista |
mints
• Optional mints: { id: number ; letter?: string }[]
Mints where the coin was minted
obverse
• Optional obverse: TypeSideUpdate
orientation
• Optional orientation: Orientation
Orientation of the coin (“coin”, “medal” or “variable”)
printers
• Optional printers: { id: number }[]
Printers where the banknote was printed
references
• Optional references: { catalogue: { id: number } ; number: string }[]
related_coins
• Optional related_coins: { id: number }[]
List of related types
reverse
• Optional reverse: TypeSideUpdate
ruling_authority
• Optional ruling_authority: { id: number }[]
Ruling authorities (emperor, queen, period, etc.)
series
• Optional series: LocalizedLabel[]
For types which are part of a series, the name of the series
shape
• Optional shape: Object
Shape
Type declaration
| Name | Type | Description |
|---|---|---|
additional_details? |
LocalizedLabel[] |
- |
id |
number |
Unique ID of the shape on Numista |
size
• Optional size: number
Size (diameter) in millimeters
tags
• Optional tags: { id: number }[]
List of tags
technique
• Optional technique: Object
Manufacturing technique
Type declaration
| Name | Type |
|---|---|
additional_details? |
LocalizedLabel[] |
list? |
{ id: number }[] |
thickness
• Optional thickness: number
Thickness of the coin in millimeters
title
• title: LocalizedLabel[]
Title of the type
type
• Optional type: string
Type
value
• Optional value: Object
Face value
Type declaration
| Name | Type | Description |
|---|---|---|
currency? |
{ id: number } |
Currency |
currency.id |
number |
Unique ID of the currency on Numista |
denominator? |
number |
If the value is better described as a fraction, this is the denominator of the fraction |
numerator? |
number |
If the value is better described as a fraction, this is the numerator of the fraction |
numeric_value? |
number |
Face value as a floating number. This field is ignored if a numerator and a denominator are provided |
text? |
LocalizedLabel[] |
Face value in text format |
watermark
• Optional watermark: TypeSideUpdate
weight
• Optional weight: number
Weight in grams