[{"data":1,"prerenderedAt":655},["ShallowReactive",2],{"doc:ws/connecting":3},{"slug":4,"filePath":5,"frontmatter":6,"rawMarkdown":9,"tree":10},"ws/connecting","ws/connecting.md",{"title":7,"description":8},"Connecting","Establish a WebSocket connection and authenticate with the API.","---\ntitle: Connecting\ndescription: Establish a WebSocket connection and authenticate with the API.\n---\n\n# Connecting\n\n## Endpoints\n\nChoose the region closest to your deployment, then choose the endpoint family that matches your channels.\n\n| Endpoint family | Use for | Singapore | Europe |\n| --- | --- | --- | --- |\n| `book` | `BLOCK_BOOK_SNAPSHOT` | `wss://ap-sin3.ws.api.kiyotaka.ai/ws` | `wss://eu-de3.ws.api.kiyotaka.ai/ws` |\n| `nonbook` | All other channels | `wss://ap-sin3.ws.api.kiyotaka.ai/nonbook/ws` | `wss://eu-de3.ws.api.kiyotaka.ai/nonbook/ws` |\n\nIf you need both orderbook and non-orderbook feeds, open one connection to each endpoint family.\nFor public API integrations, append `?encoding=json` to the endpoint you use and send JSON messages:\n\n\u003CCodeBlock lang=\"Endpoints\">\n\u003Cpre>\u003Cspan class=\"s-s\">wss://ap-sin3.ws.api.kiyotaka.ai/ws?encoding=json\u003C/span>\n\u003Cspan class=\"s-s\">wss://ap-sin3.ws.api.kiyotaka.ai/nonbook/ws?encoding=json\u003C/span>\u003C/pre>\n\u003C/CodeBlock>\n\n## Authentication\n\nAuthenticate immediately after connecting by sending your API key:\n\n\u003CCodeBlock lang=\"JSON\">\n\u003Cpre>{\n  \u003Cspan class=\"s-p\">\"method\"\u003C/span>: \u003Cspan class=\"s-s\">\"public/authenticate\"\u003C/span>,\n  \u003Cspan class=\"s-p\">\"params\"\u003C/span>: {\n    \u003Cspan class=\"s-p\">\"token\"\u003C/span>: \u003Cspan class=\"s-s\">\"YOUR_API_KEY\"\u003C/span>\n  }\n}\u003C/pre>\n\u003C/CodeBlock>\n\nYou must authenticate before subscribing to any channels.",{"type":11,"children":12,"data":649,"position":651},"root",[13,16,37,38,54,56,340,341,375,376,448,449,465,466,481,482,634,635],{"type":14,"value":15},"text","\n",{"type":17,"tagName":18,"properties":19,"children":21,"position":32},"element","h2",{"id":20},"endpoints",[22],{"type":14,"value":23,"position":24},"Endpoints",{"start":25,"end":29},{"line":26,"column":27,"offset":28},3,4,17,{"line":26,"column":30,"offset":31},13,26,{"start":33,"end":36},{"line":26,"column":34,"offset":35},1,14,{"line":26,"column":30,"offset":31},{"type":14,"value":15},{"type":17,"tagName":39,"properties":40,"children":41,"position":51},"p",{},[42],{"type":14,"value":43,"position":44},"Choose the region closest to your deployment, then choose the endpoint family that matches your channels.",{"start":45,"end":48},{"line":46,"column":34,"offset":47},5,28,{"line":46,"column":49,"offset":50},106,133,{"start":52,"end":53},{"line":46,"column":34,"offset":47},{"line":46,"column":49,"offset":50},{"type":14,"value":55},"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",{"type":17,"tagName":57,"properties":58,"children":59,"position":337},"table",{},[60,143],{"type":17,"tagName":61,"properties":62,"children":63,"position":140},"thead",{},[64],{"type":17,"tagName":65,"properties":66,"children":67,"position":137},"tr",{},[68,87,103,120],{"type":17,"tagName":69,"properties":70,"children":71,"position":81},"th",{},[72],{"type":14,"value":73,"position":74},"Endpoint family",{"start":75,"end":78},{"line":76,"column":26,"offset":77},7,137,{"line":76,"column":79,"offset":80},18,152,{"start":82,"end":84},{"line":76,"column":34,"offset":83},135,{"line":76,"column":85,"offset":86},19,153,{"type":17,"tagName":69,"properties":88,"children":89,"position":98},{},[90],{"type":14,"value":91,"position":92},"Use for",{"start":93,"end":96},{"line":76,"column":94,"offset":95},21,155,{"line":76,"column":47,"offset":97},162,{"start":99,"end":100},{"line":76,"column":85,"offset":86},{"line":76,"column":101,"offset":102},29,163,{"type":17,"tagName":69,"properties":104,"children":105,"position":115},{},[106],{"type":14,"value":107,"position":108},"Singapore",{"start":109,"end":112},{"line":76,"column":110,"offset":111},31,165,{"line":76,"column":113,"offset":114},40,174,{"start":116,"end":117},{"line":76,"column":101,"offset":102},{"line":76,"column":118,"offset":119},41,175,{"type":17,"tagName":69,"properties":121,"children":122,"position":132},{},[123],{"type":14,"value":124,"position":125},"Europe",{"start":126,"end":129},{"line":76,"column":127,"offset":128},43,177,{"line":76,"column":130,"offset":131},49,183,{"start":133,"end":134},{"line":76,"column":118,"offset":119},{"line":76,"column":135,"offset":136},51,185,{"start":138,"end":139},{"line":76,"column":34,"offset":83},{"line":76,"column":135,"offset":136},{"start":141,"end":142},{"line":76,"column":34,"offset":83},{"line":76,"column":135,"offset":136},{"type":17,"tagName":144,"properties":145,"children":146,"position":334},"tbody",{},[147,247],{"type":17,"tagName":65,"properties":148,"children":149,"position":244},{},[150,175,198,221],{"type":17,"tagName":151,"properties":152,"children":153,"position":169},"td",{},[154],{"type":17,"tagName":155,"properties":156,"children":157,"position":166},"code",{},[158],{"type":14,"value":159,"position":160},"book",{"start":161,"end":164},{"line":162,"column":26,"offset":163},9,214,{"line":162,"column":162,"offset":165},220,{"start":167,"end":168},{"line":162,"column":26,"offset":163},{"line":162,"column":162,"offset":165},{"start":170,"end":172},{"line":162,"column":34,"offset":171},212,{"line":162,"column":173,"offset":174},10,221,{"type":17,"tagName":151,"properties":176,"children":177,"position":193},{},[178],{"type":17,"tagName":155,"properties":179,"children":180,"position":190},{},[181],{"type":14,"value":182,"position":183},"BLOCK_BOOK_SNAPSHOT",{"start":184,"end":187},{"line":162,"column":185,"offset":186},12,223,{"line":162,"column":188,"offset":189},33,244,{"start":191,"end":192},{"line":162,"column":185,"offset":186},{"line":162,"column":188,"offset":189},{"start":194,"end":195},{"line":162,"column":173,"offset":174},{"line":162,"column":196,"offset":197},34,245,{"type":17,"tagName":151,"properties":199,"children":200,"position":216},{},[201],{"type":17,"tagName":155,"properties":202,"children":203,"position":213},{},[204],{"type":14,"value":205,"position":206},"wss://ap-sin3.ws.api.kiyotaka.ai/ws",{"start":207,"end":210},{"line":162,"column":208,"offset":209},36,247,{"line":162,"column":211,"offset":212},73,284,{"start":214,"end":215},{"line":162,"column":208,"offset":209},{"line":162,"column":211,"offset":212},{"start":217,"end":218},{"line":162,"column":196,"offset":197},{"line":162,"column":219,"offset":220},74,285,{"type":17,"tagName":151,"properties":222,"children":223,"position":239},{},[224],{"type":17,"tagName":155,"properties":225,"children":226,"position":236},{},[227],{"type":14,"value":228,"position":229},"wss://eu-de3.ws.api.kiyotaka.ai/ws",{"start":230,"end":233},{"line":162,"column":231,"offset":232},76,287,{"line":162,"column":234,"offset":235},112,323,{"start":237,"end":238},{"line":162,"column":231,"offset":232},{"line":162,"column":234,"offset":235},{"start":240,"end":241},{"line":162,"column":219,"offset":220},{"line":162,"column":242,"offset":243},114,325,{"start":245,"end":246},{"line":162,"column":34,"offset":171},{"line":162,"column":242,"offset":243},{"type":17,"tagName":65,"properties":248,"children":249,"position":331},{},[250,271,286,308],{"type":17,"tagName":151,"properties":251,"children":252,"position":266},{},[253],{"type":17,"tagName":155,"properties":254,"children":255,"position":263},{},[256],{"type":14,"value":257,"position":258},"nonbook",{"start":259,"end":261},{"line":173,"column":26,"offset":260},328,{"line":173,"column":185,"offset":262},337,{"start":264,"end":265},{"line":173,"column":26,"offset":260},{"line":173,"column":185,"offset":262},{"start":267,"end":269},{"line":173,"column":34,"offset":268},326,{"line":173,"column":30,"offset":270},338,{"type":17,"tagName":151,"properties":272,"children":273,"position":282},{},[274],{"type":14,"value":275,"position":276},"All other channels",{"start":277,"end":280},{"line":173,"column":278,"offset":279},15,340,{"line":173,"column":188,"offset":281},358,{"start":283,"end":284},{"line":173,"column":30,"offset":270},{"line":173,"column":196,"offset":285},359,{"type":17,"tagName":151,"properties":287,"children":288,"position":303},{},[289],{"type":17,"tagName":155,"properties":290,"children":291,"position":300},{},[292],{"type":14,"value":293,"position":294},"wss://ap-sin3.ws.api.kiyotaka.ai/nonbook/ws",{"start":295,"end":297},{"line":173,"column":208,"offset":296},361,{"line":173,"column":298,"offset":299},81,406,{"start":301,"end":302},{"line":173,"column":208,"offset":296},{"line":173,"column":298,"offset":299},{"start":304,"end":305},{"line":173,"column":196,"offset":285},{"line":173,"column":306,"offset":307},82,407,{"type":17,"tagName":151,"properties":309,"children":310,"position":326},{},[311],{"type":17,"tagName":155,"properties":312,"children":313,"position":323},{},[314],{"type":14,"value":315,"position":316},"wss://eu-de3.ws.api.kiyotaka.ai/nonbook/ws",{"start":317,"end":320},{"line":173,"column":318,"offset":319},84,409,{"line":173,"column":321,"offset":322},128,453,{"start":324,"end":325},{"line":173,"column":318,"offset":319},{"line":173,"column":321,"offset":322},{"start":327,"end":328},{"line":173,"column":306,"offset":307},{"line":173,"column":329,"offset":330},130,455,{"start":332,"end":333},{"line":173,"column":34,"offset":268},{"line":173,"column":329,"offset":330},{"start":335,"end":336},{"line":162,"column":34,"offset":171},{"line":173,"column":329,"offset":330},{"start":338,"end":339},{"line":76,"column":34,"offset":83},{"line":173,"column":329,"offset":330},{"type":14,"value":15},{"type":17,"tagName":39,"properties":342,"children":343,"position":372},{},[344,352,365],{"type":14,"value":345,"position":346},"If you need both orderbook and non-orderbook feeds, open one connection to each endpoint family.\nFor public API integrations, append ",{"start":347,"end":349},{"line":185,"column":34,"offset":348},457,{"line":30,"column":350,"offset":351},37,590,{"type":17,"tagName":155,"properties":353,"children":354,"position":362},{},[355],{"type":14,"value":356,"position":357},"?encoding=json",{"start":358,"end":359},{"line":30,"column":350,"offset":351},{"line":30,"column":360,"offset":361},53,606,{"start":363,"end":364},{"line":30,"column":350,"offset":351},{"line":30,"column":360,"offset":361},{"type":14,"value":366,"position":367}," to the endpoint you use and send JSON messages:",{"start":368,"end":369},{"line":30,"column":360,"offset":361},{"line":30,"column":370,"offset":371},101,654,{"start":373,"end":374},{"line":185,"column":34,"offset":348},{"line":30,"column":370,"offset":371},{"type":14,"value":15},{"type":17,"tagName":377,"properties":378,"children":379,"position":443},"codeblock",{"lang":23},[380,387,438],{"type":14,"value":15,"position":381},{"start":382,"end":384},{"line":278,"column":101,"offset":383},684,{"line":385,"column":34,"offset":386},16,685,{"type":17,"tagName":388,"properties":389,"children":390,"position":433},"pre",{},[391,412,417],{"type":17,"tagName":392,"properties":393,"children":396,"position":405},"span",{"className":394},[395],"s-s",[397],{"type":14,"value":398,"position":399},"wss://ap-sin3.ws.api.kiyotaka.ai/ws?encoding=json",{"start":400,"end":403},{"line":385,"column":401,"offset":402},24,708,{"line":385,"column":211,"offset":404},757,{"start":406,"end":409},{"line":385,"column":407,"offset":408},6,690,{"line":385,"column":410,"offset":411},80,764,{"type":14,"value":15,"position":413},{"start":414,"end":415},{"line":385,"column":410,"offset":411},{"line":28,"column":34,"offset":416},765,{"type":17,"tagName":392,"properties":418,"children":420,"position":428},{"className":419},[395],[421],{"type":14,"value":422,"position":423},"wss://ap-sin3.ws.api.kiyotaka.ai/nonbook/ws?encoding=json",{"start":424,"end":426},{"line":28,"column":85,"offset":425},783,{"line":28,"column":231,"offset":427},840,{"start":429,"end":430},{"line":28,"column":34,"offset":416},{"line":28,"column":431,"offset":432},83,847,{"start":434,"end":435},{"line":385,"column":34,"offset":386},{"line":28,"column":436,"offset":437},89,853,{"type":14,"value":15,"position":439},{"start":440,"end":441},{"line":28,"column":436,"offset":437},{"line":79,"column":34,"offset":442},854,{"start":444,"end":446},{"line":278,"column":34,"offset":445},656,{"line":79,"column":30,"offset":447},866,{"type":14,"value":15},{"type":17,"tagName":18,"properties":450,"children":452,"position":461},{"id":451},"authentication",[453],{"type":14,"value":454,"position":455},"Authentication",{"start":456,"end":459},{"line":457,"column":27,"offset":458},20,871,{"line":457,"column":79,"offset":460},885,{"start":462,"end":464},{"line":457,"column":34,"offset":463},868,{"line":457,"column":79,"offset":460},{"type":14,"value":15},{"type":17,"tagName":39,"properties":467,"children":468,"position":478},{},[469],{"type":14,"value":470,"position":471},"Authenticate immediately after connecting by sending your API key:",{"start":472,"end":475},{"line":473,"column":34,"offset":474},22,887,{"line":473,"column":476,"offset":477},67,953,{"start":479,"end":480},{"line":473,"column":34,"offset":474},{"line":473,"column":476,"offset":477},{"type":14,"value":15},{"type":17,"tagName":377,"properties":483,"children":485,"position":629},{"lang":484},"JSON",[486,493,624],{"type":14,"value":15,"position":487},{"start":488,"end":490},{"line":401,"column":401,"offset":489},978,{"line":491,"column":34,"offset":492},25,979,{"type":17,"tagName":388,"properties":494,"children":495,"position":619},{},[496,503,519,526,543,550,565,571,588,594,612],{"type":14,"value":497,"position":498},"{\n  ",{"start":499,"end":501},{"line":491,"column":407,"offset":500},984,{"line":31,"column":26,"offset":502},988,{"type":17,"tagName":392,"properties":504,"children":507,"position":515},{"className":505},[506],"s-p",[508],{"type":14,"value":509,"position":510},"\"method\"",{"start":511,"end":513},{"line":31,"column":94,"offset":512},1006,{"line":31,"column":101,"offset":514},1014,{"start":516,"end":517},{"line":31,"column":26,"offset":502},{"line":31,"column":208,"offset":518},1021,{"type":14,"value":520,"position":521},": ",{"start":522,"end":523},{"line":31,"column":208,"offset":518},{"line":31,"column":524,"offset":525},38,1023,{"type":17,"tagName":392,"properties":527,"children":529,"position":539},{"className":528},[395],[530],{"type":14,"value":531,"position":532},"\"public/authenticate\"",{"start":533,"end":536},{"line":31,"column":534,"offset":535},56,1041,{"line":31,"column":537,"offset":538},77,1062,{"start":540,"end":541},{"line":31,"column":524,"offset":525},{"line":31,"column":318,"offset":542},1069,{"type":14,"value":544,"position":545},",\n  ",{"start":546,"end":547},{"line":31,"column":318,"offset":542},{"line":548,"column":26,"offset":549},27,1073,{"type":17,"tagName":392,"properties":551,"children":553,"position":561},{"className":552},[506],[554],{"type":14,"value":555,"position":556},"\"params\"",{"start":557,"end":559},{"line":548,"column":94,"offset":558},1091,{"line":548,"column":101,"offset":560},1099,{"start":562,"end":563},{"line":548,"column":26,"offset":549},{"line":548,"column":208,"offset":564},1106,{"type":14,"value":566,"position":567},": {\n    ",{"start":568,"end":569},{"line":548,"column":208,"offset":564},{"line":47,"column":46,"offset":570},1114,{"type":17,"tagName":392,"properties":572,"children":574,"position":584},{"className":573},[506],[575],{"type":14,"value":576,"position":577},"\"token\"",{"start":578,"end":581},{"line":47,"column":579,"offset":580},23,1132,{"line":47,"column":582,"offset":583},30,1139,{"start":585,"end":586},{"line":47,"column":46,"offset":570},{"line":47,"column":350,"offset":587},1146,{"type":14,"value":520,"position":589},{"start":590,"end":591},{"line":47,"column":350,"offset":587},{"line":47,"column":592,"offset":593},39,1148,{"type":17,"tagName":392,"properties":595,"children":597,"position":607},{"className":596},[395],[598],{"type":14,"value":599,"position":600},"\"YOUR_API_KEY\"",{"start":601,"end":604},{"line":47,"column":602,"offset":603},57,1166,{"line":47,"column":605,"offset":606},71,1180,{"start":608,"end":609},{"line":47,"column":592,"offset":593},{"line":47,"column":610,"offset":611},78,1187,{"type":14,"value":613,"position":614},"\n  }\n}",{"start":615,"end":616},{"line":47,"column":610,"offset":611},{"line":582,"column":617,"offset":618},2,1193,{"start":620,"end":621},{"line":491,"column":34,"offset":492},{"line":582,"column":622,"offset":623},8,1199,{"type":14,"value":15,"position":625},{"start":626,"end":627},{"line":582,"column":622,"offset":623},{"line":110,"column":34,"offset":628},1200,{"start":630,"end":632},{"line":401,"column":34,"offset":631},955,{"line":110,"column":30,"offset":633},1212,{"type":14,"value":15},{"type":17,"tagName":39,"properties":636,"children":637,"position":646},{},[638],{"type":14,"value":639,"position":640},"You must authenticate before subscribing to any channels.",{"start":641,"end":643},{"line":188,"column":34,"offset":642},1214,{"line":188,"column":644,"offset":645},58,1271,{"start":647,"end":648},{"line":188,"column":34,"offset":642},{"line":188,"column":644,"offset":645},{"quirksMode":650},false,{"start":652,"end":654},{"line":34,"column":34,"offset":653},0,{"line":188,"column":644,"offset":645},1781011092480]