Codepoints.net Unicode API (1.0.0)

Download OpenAPI specification:Download

Welcome to codepoint.net’s Unicode API. Most requests are JSON-based. The glyph and property methods return PNG images. When problems appear, the API response conforms to RFC 7807 https://tools.ietf.org/html/rfc7807. Documentation is published at https://github.com/Codepoints/codepoints.net/wiki/API.

API documentation on Github

show detailed information about a single code point

You can specify fields of interest with the “property” parameter: codepoint/1234?property=age,uc,lc.

path Parameters

codepoint

required

string (codepoint) ^(10|[1-9A-Fa-f])?([0-9A-Fa-f]{4})$

A hexadecimal code point between 0 and 10FFFF inclusively.

query Parameters

property

Array of strings

a comma-separated allow-list of properties to include

Responses

Response samples

200

Content type

application/json

{"cp": 0,
"age": "string",
"na": "string",
"na1": "string",
"gc": "string",
"ccc": "string",
"bc": "string",
"Bidi_M": true,
"Bidi_C": true,
"dt": "string",
"CE": true,
"Comp_Ex": true,
"NFC_QC": "string",
"NFD_QC": "string",
"NFKC_QC": "string",
"NFKD_QC": "string",
"XO_NFC": true,
"XO_NFD": true,
"XO_NFKC": true,
"XO_NFKD": true,
"nt": "string",
"nv": 0,
"jt": "string",
"jg": "string",
"Join_C": true,
"lb": "string",
"ea": "string",
"Upper": true,
"Lower": true,
"OUpper": true,
"OLower": true,
"CI": true,
"Cased": true,
"CWCF": true,
"CWCM": true,
"CWL": true,
"CWKCF": true,
"CWT": true,
"CWU": true,
"isc": "string",
"hst": "string",
"JSN": "string",
"InSC": "string",
"InMC": "string",
"InPC": "string",
"IDS": true,
"OIDS": true,
"XIDS": true,
"IDC": true,
"OIDC": true,
"XIDC": true,
"Pat_Syn": true,
"Pat_WS": true,
"Dash": true,
"Hyphen": true,
"QMark": true,
"Term": true,
"STerm": true,
"Dia": true,
"Ext": true,
"SD": true,
"Alpha": true,
"OAlpha": true,
"Math": true,
"OMath": true,
"Hex": true,
"AHex": true,
"DI": true,
"ODI": true,
"LOE": true,
"WSpace": true,
"Gr_Base": true,
"Gr_Ext": true,
"OGr_Ext": true,
"Gr_Link": true,
"GCB": "string",
"WB": "string",
"SB": "string",
"Ideo": true,
"UIdeo": true,
"IDSB": true,
"IDST": true,
"Radical": true,
"Dep": true,
"VS": true,
"NChar": true,
"kAccountingNumeric": "string",
"kAlternateHanYu": "string",
"kAlternateJEF": "string",
"kAlternateKangXi": "string",
"kAlternateMorohashi": "string",
"kBigFive": "string",
"kCCCII": "string",
"kCNS1986": "string",
"kCNS1992": "string",
"kCangjie": "string",
"kCantonese": "string",
"kCheungBauer": "string",
"kCheungBauerIndex": "string",
"kCihaiT": "string",
"kCompatibilityVariant": "string",
"kCowles": "string",
"kDaeJaweon": "string",
"kDefinition": "string",
"kEACC": "string",
"kFenn": "string",
"kFennIndex": "string",
"kFourCornerCode": "string",
"kFrequency": "string",
"kGB0": "string",
"kGB1": "string",
"kGB3": "string",
"kGB5": "string",
"kGB7": "string",
"kGB8": "string",
"kGradeLevel": "string",
"kGSR": "string",
"kHangul": "string",
"kHanYu": "string",
"kHanyuPinlu": "string",
"kHanyuPinyin": "string",
"kHDZRadBreak": "string",
"kHKGlyph": "string",
"kHKSCS": "string",
"kIBMJapan": "string",
"kIICore": "string",
"kIRGDaeJaweon": "string",
"kIRGDaiKanwaZiten": "string",
"kIRGHanyuDaZidian": "string",
"kIRGKangXi": "string",
"kIRG_GSource": "string",
"kIRG_HSource": "string",
"kIRG_JSource": "string",
"kIRG_KPSource": "string",
"kIRG_KSource": "string",
"kIRG_MSource": "string",
"kIRG_TSource": "string",
"kIRG_USource": "string",
"kIRG_VSource": "string",
"kJHJ": "string",
"kJIS0213": "string",
"kJa": "string",
"kJapaneseKun": "string",
"kJapaneseOn": "string",
"kJis0": "string",
"kJis1": "string",
"kKPS0": "string",
"kKPS1": "string",
"kKSC0": "string",
"kKSC1": "string",
"kKangXi": "string",
"kKarlgren": "string",
"kKorean": "string",
"kLau": "string",
"kMainlandTelegraph": "string",
"kMandarin": "string",
"kMatthews": "string",
"kMeyerWempe": "string",
"kMorohashi": "string",
"kNelson": "string",
"kOtherNumeric": "string",
"kPhonetic": "string",
"kPrimaryNumeric": "string",
"kPseudoGB1": "string",
"kRSAdobe_Japan1_6": "string",
"kRSJapanese": "string",
"kRSKanWa": "string",
"kRSKangXi": "string",
"kRSKorean": "string",
"kRSMerged": "string",
"kRSUnicode": "string",
"kSBGY": "string",
"kSemanticVariant": "string",
"kSimplifiedVariant": "string",
"kSpecializedSemanticVariant": "string",
"kTaiwanTelegraph": "string",
"kTang": "string",
"kTotalStrokes": "string",
"kTraditionalVariant": "string",
"kVietnamese": "string",
"kXHC1983": "string",
"kWubi": "string",
"kXerox": "string",
"kZVariant": "string",
"blk": "string",
"scx": "string",
"bpt": "string",
"image": "string",
"sc": "string",
"abstract": "string",
"cf": [0
],
"NFKC_CF": [0
],
"lc": [0
],
"FC_NFKC": [0
],
"slc": [0
],
"bpb": [0
],
"uc": [0
],
"tc": [0
],
"suc": [0
],
"stc": [0
],
"scf": [0
],
"dm": [0
]
}

show detailed information about a Unicode block

path Parameters

block

required

string

the name of the block in abbreviated Unicode notation

Responses

Response samples

200

Content type

application/json

{"name": "string",
"first": "string",
"last": "string",
"next_block": "string",
"prev_block": "string"
}

show information about a Unicode plane

path Parameters

plane

required

string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"first": "string",
"last": "string",
"blocks": ["string"
],
"next_plane": "string",
"prev_plane": "string"
}

get an example glyph for a code point as PNG

path Parameters

codepoint

required

string (codepoint) ^(10|[1-9A-Fa-f])?([0-9A-Fa-f]{4})$

A hexadecimal code point between 0 and 10FFFF inclusively.

Responses

get the canonical Unicode name for a code point

path Parameters

codepoint

required

string (codepoint) ^(10|[1-9A-Fa-f])?([0-9A-Fa-f]{4})$

A hexadecimal code point between 0 and 10FFFF inclusively.

Responses

Response samples

200

Content type

"string"

transform a string to another according to a mapping, e.g., making all characters upper-case.

path Parameters

action required	string Enum: "lower" "upper" "title" "mirror" "nfc" "nfd" "nfkc" "nfkd"
data required	string

Responses

Response samples

200

Content type

"string"

Filter a string of characters by Unicode property

You can negate properties by appending a “!” to it: filter/string?age!=5.5 finds all characters in “string” that were not added in Unicode 5.5.

path Parameters

data

required

string

query Parameters

property

string

Responses

Response samples

200

Content type

"string"

show a PNG image where every code point is represented by one pixel

The pixel color determines the value.

path Parameters

property

required

string

Responses

Specify one or more ISO short names separated by comma

path Parameters

iso

required

string^[A-Z][a-z]{3}$

Responses

Response samples

200

Content type

application/json

{"name": "string"
}

search for code points by their properties

query Parameters

property	string
page	integer >= 1
per_page	integer >= 1

Responses

Response samples

200

Content type

application/json

{"results": [0
],
"page": 0,
"last_page": 0,
"per_page": 0,
"count": 0
}

oEmbed API endpoint for URLs matching “codepoints.net”

query Parameters

url	string <uri>
format	string Enum: "xml" "json"
maxwidth	integer
maxheight	integer

Responses

Response samples

200

Content type

application/json

{"type": "rich",
"version": "1.0",
"title": "string",
"author_url": "string",
"provider_name": "Codepoints.net",
"provider_url": "string",
"cache_age": 0,
"thumbnail_url": "string",
"html": "string",
"width": 0,
"height": 0
}