API Specification Revision History

Files changed (1) hide show
  1. old.yml 2025-08-08 16:12:39 → 21_インターフェース/1_1_API仕様書.yml 2025-08-08 15:41:12 +3 -3
old.yml 2025-08-08 16:12:39 → 21_インターフェース/1_1_API仕様書.yml 2025-08-08 15:41:12 RENAMED
@@ -1,958 +1,958 @@
1
  openapi: 3.0.0
2
  servers:
3
  - url: https://crednex.jpx.co.jp/api/v1
4
  description: Production server
5
  - url: https://stg.crednex.jpx.co.jp/api/v1
6
  description: Staging server
7
  info:
8
  title: ETF Creation Redemption Platform (CredNex) API Specification
9
- version: 1.1.0
10
  description: |
11
  ## Outline
12
 
13
  #### Production Environment
14
 
15
  URL: https://crednex.jpx.co.jp/api/v1
16
 
17
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
18
 
19
  #### Demo Environment
20
 
21
  URL: https://stg.crednex.jpx.co.jp/api/v1
22
 
23
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
24
 
25
 
26
  #### Network
27
 
28
  - The access route is provided only via the Internet.
29
  - Global IP for each environment of this system is not fixed.
30
 
31
  ## Preparations
32
 
33
 
34
  #### API Key
35
 
36
  Getting an API key is required.
37
  An API key is an unique key for each API user.
38
  It is used for this service to identify API users.
39
  Any API users who wish to use the APIs on this service must request TSE to issue API keys in advance.
40
  The API key should be set in the X-API-KEY in header every time you send an API call.
41
 
42
 
43
  #### IP Address Whitelisting
44
 
45
  You must submit the global IP address of the system making API calls to TSE.
46
  All API keys are linked to global IP addresses, and API calls from IP addresses not submitted in advance will not be accepted.
47
 
48
 
49
  #### Rate Limits
50
 
51
  The maximum frequency of API calls is limited to approximately once every second per API key. This value is subject to change in the future.
52
  When the limit is reached, the user will receive an error response.
53
  Overly frequent access is prohibited as stated in the Terms and Conditions. If such behavior is detected, TSE may issue a warning to the user.
54
 
55
  ## Authorization
56
 
57
  |Method|Endpoint|MM|AP (Agency)|AP (Prop)|
58
  |:----|:----|:----|:----|:----|
59
  |GET|ANY|Available|Available|Available|
60
- |POST|/applications|Available|N/A|Available|
61
  |PUT|/applications/{applicationId}/approve|N/A|Available|Available|
62
  |PUT|/applications/{applicationId}/deny|N/A|Available|Available|
63
  |PUT|/applications/{applicationId}/approveCancellationRequest|N/A|Available|Available|
64
  |PUT|/applications/{applicationId}/denyCancellationRequest|N/A|Available|Available|
65
  |PUT|/applications/{applicationId}/cancellationRequest|Available|N/A|Available|
66
 
67
 
68
  paths:
69
  /applications:
70
  get:
71
  summary: Get applicationId of creation and redemption application
72
  description: Get applicationId for which the user has permissions to view
73
  operationId: getApplicationIds
74
  tags:
75
  - applications
76
  parameters:
77
  - name: applicationDate
78
  in: query
79
  schema:
80
  type: string
81
  format: date
82
  description: Application date
83
  - name: statementFixingDate
84
  in: query
85
  schema:
86
  type: string
87
  format: date
88
  description: Statement fixing date
89
  - name: status
90
  in: query
91
  schema:
92
  type: string
93
  description: Specify the status of the creation and redemption applications
94
  responses:
95
  '200':
96
  description: Success operation
97
  content:
98
  application/json:
99
  schema:
100
  type: object
101
  properties:
102
  applications:
103
  type: array
104
  items:
105
  type: object
106
  properties:
107
  id:
108
  type: string
109
  example: '2024123100010001'
110
  description: Application ID
111
  status:
112
  type: string
113
  enum:
114
  - "ApplicationInProcessAP"
115
  - "ApplicationInProcessAM"
116
  - "Accepted"
117
  - "StatementInProcessTB"
118
  - "StatementReturnedForRevisionAM"
119
  - "StatementFixed"
120
  - "CancelRequestInProcessAP"
121
  - "CancelRequestInProcessAM"
122
  - "Canceled"
123
  hasMore:
124
  type: boolean
125
  example: false
126
  description: Whether there are more than 1,000 application IDs. If true, please send a request again by narrowing down the conditions such as application date, statement fixing date, and status.
127
  post:
128
  summary: Register for your creation/redemption application
129
  description: |
130
  Fill in the information required to apply for creation/redemption and register your application.
131
 
132
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
133
  The value set depends on `clearingType` of the issue being applied for.
134
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
135
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
136
  operationId: registerApplication
137
  tags:
138
  - applications
139
  requestBody:
140
  required: true
141
  content:
142
  application/json:
143
  schema:
144
  $ref: '#/components/schemas/Application'
145
  responses:
146
  '201':
147
  description: Created
148
  content:
149
  application/json:
150
  schema:
151
  type: object
152
  properties:
153
  applicationId:
154
  type: string
155
  example: '2024123100010001'
156
  '400':
157
  description: "Bad Request"
158
  content:
159
  application/json:
160
  schema:
161
  type: object
162
  properties:
163
  message:
164
  type: string
165
  enum:
166
  - ETF code or AP code is incorrect.
167
  - Application date is incorrect.
168
  - Cut-off time for this ETF fund has already elapsed.
169
  - Number of shares is incorrect.
170
  - The number of digits in 'numberOfShares' is exceeded.
171
  - Number of shares must be an integer multiple of the order unit.
172
  - Number of shares must be exceeded the minimum.
173
- - Number of shares must be an integer multiple of the trading unit.
174
  - This issue can only be applied with clearing.
175
  - This issue can only be applied with non-clearing.
176
  example: 'ETF code or AP code is incorrect.'
177
  '403':
178
  description: 'Forbidden'
179
  content:
180
  application/json:
181
  schema:
182
  type: object
183
  properties:
184
  message:
185
  type: string
186
  example: 'You are not allowed to register an application.'
187
  /applications/{applicationId}:
188
  get:
189
  summary: Get detailed application information
190
  description: 'Specify the applicationId to get details of the applications that the user has permission to view.'
191
  parameters:
192
  - $ref: '#/components/parameters/applicationId'
193
  operationId: getApplicationDetails
194
  tags:
195
  - applications
196
  responses:
197
  '200':
198
  description: Success operation
199
  content:
200
  application/json:
201
  schema:
202
  $ref: '#/components/schemas/ApplicationInfo'
203
  '403':
204
  description: 'Forbidden'
205
  content:
206
  application/json:
207
  schema:
208
  type: object
209
  properties:
210
  message:
211
  type: string
212
  example: 'You are not allowed to access this application.'
213
  /applications/{applicationId}/approve:
214
  put:
215
  summary: Approve a creation/redemption application
216
  parameters:
217
  - $ref: '#/components/parameters/applicationId'
218
  description: 'Approve an application from market makers.'
219
  operationId: approveApplication
220
  tags:
221
  - applications
222
  responses:
223
  '200':
224
  description: Success operation
225
  '400':
226
  description: 'Bad Request'
227
  content:
228
  application/json:
229
  schema:
230
  type: object
231
  properties:
232
  message:
233
  type: string
234
  enum:
235
  - This approval is not available for this application ID.
236
  - This application cannot be approved because it has exceeded the cut-off.
237
  example: 'This approval is not available for this application ID.'
238
  '403':
239
  description: 'Forbidden'
240
  content:
241
  application/json:
242
  schema:
243
  type: object
244
  properties:
245
  message:
246
  type: string
247
  example: 'You are not allowed to access this application.'
248
  /applications/{applicationId}/deny:
249
  put:
250
  summary: Deny a creation/redemption application
251
  parameters:
252
  - $ref: '#/components/parameters/applicationId'
253
  description: 'Deny an application from market makers.'
254
  operationId: denyApplication
255
  tags:
256
  - applications
257
  responses:
258
  '200':
259
  description: Success operation
260
  '400':
261
  description: 'Bad Request'
262
  content:
263
  application/json:
264
  schema:
265
  type: object
266
  properties:
267
  message:
268
  type: string
269
  example: 'This denial is not available for this application ID.'
270
  '403':
271
  description: 'Forbidden'
272
  content:
273
  application/json:
274
  schema:
275
  type: object
276
  properties:
277
  message:
278
  type: string
279
  example: 'You are not allowed to access this application.'
280
  /applications/{applicationId}/approveCancellationRequest:
281
  put:
282
  summary: Approve a cancellation request
283
  parameters:
284
  - $ref: '#/components/parameters/applicationId'
285
  description: 'Approve a cancellation request from market makers.'
286
  operationId: approveCancellationRequest
287
  tags:
288
  - applications
289
  responses:
290
  '200':
291
  description: Success operation
292
  '400':
293
  description: 'Bad Request'
294
  content:
295
  application/json:
296
  schema:
297
  type: object
298
  properties:
299
  message:
300
  type: string
301
  example: 'This approval is not available for this application ID.'
302
  '403':
303
  description: 'Forbidden'
304
  content:
305
  application/json:
306
  schema:
307
  type: object
308
  properties:
309
  message:
310
  type: string
311
  example: 'You are not allowed to access this application.'
312
  /applications/{applicationId}/denyCancellationRequest:
313
  put:
314
  summary: Deny a cancellation request
315
  parameters:
316
  - $ref: '#/components/parameters/applicationId'
317
  description: 'Deny a cancellation request from market makers.'
318
  operationId: denyCancellationRequest
319
  tags:
320
  - applications
321
  responses:
322
  '200':
323
  description: Success operation
324
  '400':
325
  description: 'Bad Request'
326
  content:
327
  application/json:
328
  schema:
329
  type: object
330
  properties:
331
  message:
332
  type: string
333
  example: 'This denial is not available for this application ID.'
334
  '403':
335
  description: 'Forbidden'
336
  content:
337
  application/json:
338
  schema:
339
  type: object
340
  properties:
341
  message:
342
  type: string
343
  example: 'You are not allowed to access this application.'
344
  /applications/{applicationId}/cancellationRequest:
345
  put:
346
  summary: Request APs to cancel an application
347
  parameters:
348
  - $ref: '#/components/parameters/applicationId'
349
  description: 'Request APs to cancel a registered application.'
350
  operationId: cancellationRequest
351
  tags:
352
  - applications
353
  responses:
354
  '200':
355
  description: Success operation
356
  '400':
357
  description: 'Bad Request'
358
  content:
359
  application/json:
360
  schema:
361
  type: object
362
  properties:
363
  message:
364
  type: string
365
  example: 'Cancellation is not available for this application ID.'
366
  '403':
367
  description: 'Forbidden'
368
  content:
369
  application/json:
370
  schema:
371
  type: object
372
  properties:
373
  message:
374
  type: string
375
  example: 'You are not allowed to access this application.'
376
  /statements/{applicationId}:
377
  get:
378
  summary: Get statement data
379
  description: Get statement data for each applicationId.
380
  operationId: getStatementjson
381
  parameters:
382
  - $ref: '#/components/parameters/applicationId'
383
  tags:
384
  - applications
385
  responses:
386
  '200':
387
  description: Success operation
388
  content:
389
  application/json:
390
  schema:
391
  $ref: '#/components/schemas/Statements'
392
  '400':
393
  description: 'Bad Request'
394
  content:
395
  application/json:
396
  schema:
397
  type: object
398
  properties:
399
  message:
400
  type: string
401
  example: 'This request is not available for this application ID.'
402
  '403':
403
  description: 'Forbidden'
404
  content:
405
  application/json:
406
  schema:
407
  type: object
408
  properties:
409
  message:
410
  type: string
411
  example: 'You are not allowed to access this application.'
412
  /issues:
413
  get:
414
  summary: Get basic information of each issue
415
  description: Get basic information of each issue.
416
  operationId: getIssueInfojson
417
  tags:
418
  - information
419
  responses:
420
  '200':
421
  description: Success operation
422
  content:
423
  application/json:
424
  schema:
425
  $ref: '#/components/schemas/Issues'
426
  /issues/blackout:
427
  get:
428
  summary: Get blackout dates of each issue
429
  description: Get blackout dates of each issue.
430
  operationId: getBlackoutCalendarjson
431
  tags:
432
  - information
433
  responses:
434
  '200':
435
  description: Success operation
436
  content:
437
  application/json:
438
  schema:
439
  type: object
440
  properties:
441
  issues:
442
  type: array
443
  items:
444
  $ref: '#/components/schemas/Blackout'
445
  security:
446
  - ApiKeyAuth: []
447
  components:
448
  securitySchemes:
449
  ApiKeyAuth:
450
  type: apiKey
451
  in: header
452
  name: X-API-KEY
453
  schemas:
454
  Application:
455
  type: object
456
  properties:
457
  applicationDate:
458
  type: string
459
  format: date
460
  description: Application date
461
  example: '2025-04-15'
462
  apCode:
463
  type: string
464
  description: AP code. 5-digit number.
465
  example: '12345'
466
  etfCode:
467
  type: string
468
  description: ETFfund code. 5-digit alphanumeric character.
469
  example: '12340'
470
  creationOrRedemption:
471
  type: string
472
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
473
  example: 'C'
474
  numberOfShares:
475
  type: integer
476
  description: Number of shares.
477
  example: 10000
478
  format: int32
479
  pcfNumber:
480
  type: string
481
  description: PCF number. 16-digit alphanumeric character.
482
  example: '1234567890123456'
483
  notes:
484
  type: string
485
  description: Notes from market makers to APs.
486
  example: 'string'
487
  isClearing:
488
  type: boolean
489
  description: |
490
  Cleared by JSCC or non-cleared. false:non-cleared true:cleared.
491
 
492
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
493
  The value set depends on `clearingType` of the issue being applied for.
494
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
495
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
496
  example: true
497
  required:
498
  - applicationDate
499
  - apCode
500
  - etfCode
501
  - creationOrRedemption
502
  - numberOfShares
503
  ApplicationInfo:
504
  allOf:
505
  - $ref: '#/components/schemas/Application'
506
  properties:
507
  status:
508
  type: string
509
  enum:
510
  - "ApplicationInProcessAP"
511
  - "ApplicationInProcessAM"
512
  - "Accepted"
513
  - "StatementInProcessTB"
514
  - "StatementReturnedForRevisionAM"
515
  - "StatementFixed"
516
  - "CancelRequestInProcessAP"
517
  - "CancelRequestInProcessAM"
518
  - "Canceled"
519
  example: "ApplicationInProcessAP"
520
  description: Application status at the time.
521
  # codesOfTreasuryStock:
522
  # type: array
523
  # items:
524
  # type: string
525
  # example: '12340'
526
  # description: 5-digit code of treasury stock.
527
  jasdecAccountInformation:
528
  type: string
529
  example: '1234567'
530
  description: JASDEC account information. 7-digit number.
531
  navPerShareCalculationDate:
532
  type: string
533
  format: date
534
  example: '2025-05-29'
535
  description: NAV per share calculation date.
536
  statementFixingDate:
537
  type: string
538
  format: date
539
  example: '2025-05-29'
540
  description: Statement fixing date.
541
  trustEstablishmentOrCancellationDate:
542
  type: string
543
  format: date
544
  example: '2025-05-30'
545
  description: Trust establishment or cancellation date.
546
  settlementDate:
547
  type: string
548
  format: date
549
  example: '2025-05-31'
550
  description: Settlement date.
551
  dvpClearingPrice:
552
  type: string
553
  example: '12345678901234.1234'
554
  description: |
555
  DVP clearing price. Used only if an application is in cash ETF and cleared.
556
  Issues:
557
  type: object
558
  properties:
559
  issues:
560
  type: array
561
  items:
562
  type: object
563
  properties:
564
  etfCode:
565
  type: string
566
  description: ETF fund code. 5-digit alphanumeric character.
567
  example: '12340'
568
  inKindOrInCash:
569
  type: string
570
  description: Specify in-kind or in-cash.
571
  example: 'CashCreationCashRedemption'
572
  enum:
573
  - CashCreationCashRedemption
574
  - InKindCreationInKindRedemption
575
  - CashCreationInKindRedemption
576
  etfNameJa:
577
  type: string
578
  description: ETF fund name in Japanese.
579
  example: 'XXX ファンド'
580
  etfNameEn:
581
  type: string
582
  description: ETF fund name in English.
583
  example: 'XXX fund'
584
  cutoffTimeExcludingTreasuryStock:
585
  type: string
586
  description: Cut-off time (JST) for cases where the treasury stock of AP is not included in the basket. All cut-off time for in cash ETF funds are placed in this field.
587
  example: '15:30'
588
  creation:
589
  type: object
590
  properties:
591
  clearingType:
592
  type: string
593
  enum:
594
  - Clearing
595
  - Non-Clearing
596
  - Selectable
597
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
598
  example: 'Clearing'
599
  schedule:
600
  type: object
601
  properties:
602
  clearing:
603
  $ref: "#/components/schemas/CreationSchedule"
604
  nonClearing:
605
  $ref: "#/components/schemas/CreationSchedule"
606
  example:
607
  clearing:
608
  navPerShareCalculationDate: 0
609
  statementFixingDate: 1
610
  trustEstablishmentDate: 2
611
  settlementDate: 2
612
  nonClearing: null
613
  orderUnit:
614
  type: integer
615
  description: Order unit in case of creation. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
616
  example: 10000
617
  minimumNumberOfShares:
618
  type: integer
619
  description: Minimum number of shares in case of creation. If it is 30000, applicants can request in quantities of 30,000 or more.
620
  example: 30000
621
  redemption:
622
  type: object
623
  properties:
624
  clearingType:
625
  type: string
626
  enum:
627
  - Clearing
628
  - Non-Clearing
629
  - Selectable
630
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
631
  example: 'Selectable'
632
  schedule:
633
  type: object
634
  properties:
635
  clearing:
636
  $ref: "#/components/schemas/RedemptionSchedule"
637
  nonClearing:
638
  $ref: "#/components/schemas/RedemptionSchedule"
639
  example:
640
  clearing:
641
  navPerShareCalculationDate: 0
642
  statementFixingDate: 1
643
  trustCancellationDate: 2
644
  settlementDate: 2
645
  nonClearing:
646
  navPerShareCalculationDate: 0
647
  statementFixingDate: 1
648
  trustCancellationDate: 2
649
  settlementDate: 2
650
  orderUnit:
651
  type: integer
652
  description: Order unit in case of redemption. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
653
  example: 10000
654
  minimumNumberOfShares:
655
  type: integer
656
  description: Minimum number of shares in case of redemption. If it is 30000, applicants can request in quantities of 30,000 or more.
657
  example: 30000
658
  earlyRedemptionClause:
659
  type: integer
660
  description: The number of early redemption shares specified in the terms and conditions of an investment trust for each fund. This is an optional field.
661
  example: 100000
662
  issuersOptionalFundCode:
663
  type: string
664
  description: Fund code used by the issuer to identify the fund internally. This is an optional field.
665
  example: 'ABCD1234'
666
  isinCode:
667
  type: string
668
  description: ISIN code. 12-digit alphanumeric character.
669
  example: 'JP1234567890'
670
  amCode:
671
  type: string
672
  description: AM code. 5-digit number.
673
  example: '00123'
674
  amNameJa:
675
  type: string
676
  description: AM name in Japanese.
677
  example: 'XXX アセットマネジメント'
678
  amNameEn:
679
  type: string
680
  description: AM name in English.
681
  example: 'XXX Asset Management'
682
  tbCode:
683
  type: string
684
  description: TB code. 5-digit number.
685
  example: '00001'
686
  tbNameJa:
687
  type: string
688
  description: TB name in Japanese.
689
  example: 'XXX 信託銀行'
690
  tbNameEn:
691
  type: string
692
  description: TB name in English.
693
  example: 'XXX Trust Bank Co., Ltd.'
694
  handlingPeriodFrom:
695
  type: string
696
  description: Start date of available period for handling.
697
  example: '2024-12-03'
698
  handlingPeriodTo:
699
  type: string
700
  description: End date of available period for handling. If it is null, the end date is undecided.
701
  example: '2025-09-21'
702
  DateList:
703
  type: array
704
  items:
705
  type: string
706
  format: date
707
  example: '1992-12-02'
708
  Blackout:
709
  type: object
710
  properties:
711
  etfCode:
712
  type: string
713
  example: '12340'
714
  creationBlackoutDates:
715
  type: array
716
  items:
717
  type: string
718
  format: date
719
  example: '1992-12-02'
720
  redemptionBlackoutDates:
721
  type: array
722
  items:
723
  type: string
724
  format: date
725
  example: '1992-12-02'
726
 
727
  Statements:
728
  type: object
729
  properties:
730
  applicationId:
731
  type: string
732
  example: '2024123100010001'
733
  description: Application ID
734
  pcfNumber:
735
  type: string
736
  example: '1234567890123456'
737
  description: PCF number. 16-digit alphanumeric character.
738
  amCode:
739
  type: string
740
  example: '00123'
741
  description: AM code. 5-digit number.
742
  amNameJa:
743
  type: string
744
  example: 'XXX アセットマネジメント'
745
  description: AM name in Japanese.
746
  amNameEn:
747
  type: string
748
  example: 'XXX Asset Management'
749
  description: AM name in English.
750
  userId:
751
  type: string
752
  example: 'XXX@crednex.co.jp'
753
  default: User ID that registered this statement as AM
754
  apCode:
755
  type: string
756
  example: '00012'
757
  description: AP code. 5-digit number.
758
  apNameJa:
759
  type: string
760
  example: 'XXX 証券'
761
  description: AP Name in Japanese.
762
  apNameEn:
763
  type: string
764
  example: 'XXX Securities Co., Ltd.'
765
  description: AP Name in English.
766
  etfCode:
767
  type: string
768
  example: '12340'
769
  description: ETF fund code. 5-digit alphanumeric character.
770
  etfISINCode:
771
  type: string
772
  example: 'JP0000000000'
773
  description: ISIN code. 10-digit number.
774
  etfNameJa:
775
  type: string
776
  example: 'XXX ファンド'
777
  description: ETF fund name in Japanese.
778
  etfNameEn:
779
  type: string
780
  example: 'XXX fund'
781
  description: ETF fund name in English.
782
  creationOrRedemption:
783
  type: string
784
  example: 'C'
785
  description: Specify Creation or Redmption. 'C':Creation 'R':Redemption
786
  tbCode:
787
  type: string
788
  example: '00001'
789
  description: TB code. 5-digit number.
790
  tbNameJa:
791
  type: string
792
  example: 'XXX 信託銀行'
793
  description: TB name in Japanese.
794
  tbNameEn:
795
  type: string
796
  example: 'XXX Trust Bank Co., Ltd.'
797
  description: TB name in English.
798
  navPerShareCalculationDate:
799
  type: string
800
  format: date
801
  example: '2025-05-29'
802
  description: NAV per share calculation date.
803
  statementFixingDate:
804
  type: string
805
  format: date
806
  example: '2025-05-29'
807
  description: Statement fixing date.
808
  settlementDate:
809
  type: string
810
  format: date
811
  example: '2025-05-31'
812
  description: Settlement date.
813
  trustEstablishmentOrCancellationDate:
814
  type: string
815
  format: date
816
  example: '2025-05-30'
817
  description: Trust establishment or cancellation date.
818
  etfNavPerShare:
819
  type: string
820
  example: '12345678901234.1234'
821
  description: ETF nav per share.
822
  etfPurchaseOrCancellationPrice:
823
  type: string
824
  example: '12345678901234.1234'
825
  description: ETF purchase or cancellation price.
826
  numberOfShares:
827
  type: integer
828
  example: 10000
829
  format: int32
830
  description: Number of shares the client ordered.
831
  numberOfSharesOfNewRecordOrScheduledDeletion:
832
  type: integer
833
  example: 123456789012345
834
  format: int64
835
  description: The number of shares of new record or scheduled deletion.
836
  etfNetAssetValue:
837
  type: string
838
  example: '12345678901234.1234'
839
  description: ETF net asset value.
840
  executionCosts:
841
  type: string
842
  description: Execution cost of this creation/redemption for AP.
843
  optionalInputItemName1:
844
  type: string
845
  description: Name of optional item.
846
  totalPaymentAmount:
847
  type: string
848
  example: '123456789012345678'
849
  description: Total payment of this creation/redemption for AP.
850
  optionalInputItemName2:
851
  type: string
852
  optionalInputItemContent2:
853
  type: string
854
  description: Contents of optional item.
855
  optionalInputItemName3:
856
  type: string
857
  optionalInputItemContent3:
858
  type: string
859
  optionalInputItemName4:
860
  type: string
861
  statementType:
862
  type: string
863
  enum:
864
  - 'CreatedByAM'
865
  - 'CreatedByCredNex'
866
  description: |
867
  CreatedByAM: This statement is registered by AM, and transitions to 'StatementFixed' status by the deadline of the statement fixing date.
868
 
869
  CreatedByCredNex: This statement is automatically created by CredNex because the application for the statement transitions to 'Accepted', but does not transition to 'StatementFixed' status by the deadline of the statement fixing date.
870
 
871
  If the application is non-cleared, the return value for this item will be an empty string.
872
  optionalInputItemName5:
873
  type: string
874
  dvpSettlementPrice:
875
  type: string
876
  example: '12345678901234.1234'
877
  description: DVP settlement price calculated on the application date. If the application is non-cleared, the return value for this item will be an empty string.
878
  optionalInputItemName6:
879
  type: string
880
  optionalInputItemContent6:
881
  type: string
882
  optionalInputItemName7:
883
  type: string
884
  optionalInputItemContent7:
885
  type: string
886
  optionalInputItemName8:
887
  type: string
888
  optionalInputItemContent8:
889
  type: string
890
  optionalInputItemName9:
891
  type: string
892
  optionalInputItemContent9:
893
  type: string
894
  optionalInputItemName10:
895
  type: string
896
  optionalInputItemContent10:
897
  type: string
898
  notes:
899
  type: string
900
  description: Notices by AM for AP.
901
  BaseSchedule:
902
  type: object
903
  description: Schedule configuration depends on clearingType. For "Clearing", only clearing.schedule is set and nonClearing.schedule is null. For "Non-Clearing", only nonClearing.schedule is set and clearing.schedule is null. For "Selectable", both clearing.schedule and nonClearing.schedule are set.
904
  nullable: true
905
  properties:
906
  navPerShareCalculationDate:
907
  type: integer
908
  description: NAV per share calculation date. It is counted from the trade date (dayT). If it is '0', T+0 is NAV per share calculation date.
909
  example: 0
910
  statementFixingDate:
911
  type: integer
912
  description: Statement fixing date. It is counted from the trade date (dayT).
913
  example: 1
914
  settlementDate:
915
  type: integer
916
  description: Settlement date. It is counted from the trade date (dayT).
917
  example: 2
918
  CreationSchedule:
919
  allOf:
920
  - $ref: "#/components/schemas/BaseSchedule"
921
  - type: object
922
  properties:
923
  trustEstablishmentDate:
924
  type: integer
925
  description: Trust establishment date in case of creation. It is counted from the trade date (dayT).
926
  example: 2
927
  RedemptionSchedule:
928
  allOf:
929
  - $ref: "#/components/schemas/BaseSchedule"
930
  - type: object
931
  properties:
932
  trustCancellationDate:
933
  type: integer
934
  description: Trust cancellation date in case of redemption. It is counted from the trade date (dayT).
935
  example: 2
936
  parameters:
937
  applicationId:
938
  name: applicationId
939
  in: path
940
  required: true
941
  description: Application ID
942
  schema:
943
  type: string
944
  example: '2024123100010001'
945
  statementFixingDate:
946
  name: statementFixingDate
947
  in: query
948
  required: false
949
  description: Statement fixing date. Default is today (JST).
950
  schema:
951
  type: string
952
  format: date
953
  example: '2025-05-29'
954
  tags:
955
  - name: applications
956
  description: Create/Approve creation/redemption applications
957
  - name: information
958
  description: Get information related to ETF creation/redemption operations
 
1
  openapi: 3.0.0
2
  servers:
3
  - url: https://crednex.jpx.co.jp/api/v1
4
  description: Production server
5
  - url: https://stg.crednex.jpx.co.jp/api/v1
6
  description: Staging server
7
  info:
8
  title: ETF Creation Redemption Platform (CredNex) API Specification
9
+ version: 1.1.1
10
  description: |
11
  ## Outline
12
 
13
  #### Production Environment
14
 
15
  URL: https://crednex.jpx.co.jp/api/v1
16
 
17
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
18
 
19
  #### Demo Environment
20
 
21
  URL: https://stg.crednex.jpx.co.jp/api/v1
22
 
23
  Available Time: Weekdays 7:00 a.m-10:00 p.m (JST)
24
 
25
 
26
  #### Network
27
 
28
  - The access route is provided only via the Internet.
29
  - Global IP for each environment of this system is not fixed.
30
 
31
  ## Preparations
32
 
33
 
34
  #### API Key
35
 
36
  Getting an API key is required.
37
  An API key is an unique key for each API user.
38
  It is used for this service to identify API users.
39
  Any API users who wish to use the APIs on this service must request TSE to issue API keys in advance.
40
  The API key should be set in the X-API-KEY in header every time you send an API call.
41
 
42
 
43
  #### IP Address Whitelisting
44
 
45
  You must submit the global IP address of the system making API calls to TSE.
46
  All API keys are linked to global IP addresses, and API calls from IP addresses not submitted in advance will not be accepted.
47
 
48
 
49
  #### Rate Limits
50
 
51
  The maximum frequency of API calls is limited to approximately once every second per API key. This value is subject to change in the future.
52
  When the limit is reached, the user will receive an error response.
53
  Overly frequent access is prohibited as stated in the Terms and Conditions. If such behavior is detected, TSE may issue a warning to the user.
54
 
55
  ## Authorization
56
 
57
  |Method|Endpoint|MM|AP (Agency)|AP (Prop)|
58
  |:----|:----|:----|:----|:----|
59
  |GET|ANY|Available|Available|Available|
60
+ |POST|/applications|Available|Available|Available|
61
  |PUT|/applications/{applicationId}/approve|N/A|Available|Available|
62
  |PUT|/applications/{applicationId}/deny|N/A|Available|Available|
63
  |PUT|/applications/{applicationId}/approveCancellationRequest|N/A|Available|Available|
64
  |PUT|/applications/{applicationId}/denyCancellationRequest|N/A|Available|Available|
65
  |PUT|/applications/{applicationId}/cancellationRequest|Available|N/A|Available|
66
 
67
 
68
  paths:
69
  /applications:
70
  get:
71
  summary: Get applicationId of creation and redemption application
72
  description: Get applicationId for which the user has permissions to view
73
  operationId: getApplicationIds
74
  tags:
75
  - applications
76
  parameters:
77
  - name: applicationDate
78
  in: query
79
  schema:
80
  type: string
81
  format: date
82
  description: Application date
83
  - name: statementFixingDate
84
  in: query
85
  schema:
86
  type: string
87
  format: date
88
  description: Statement fixing date
89
  - name: status
90
  in: query
91
  schema:
92
  type: string
93
  description: Specify the status of the creation and redemption applications
94
  responses:
95
  '200':
96
  description: Success operation
97
  content:
98
  application/json:
99
  schema:
100
  type: object
101
  properties:
102
  applications:
103
  type: array
104
  items:
105
  type: object
106
  properties:
107
  id:
108
  type: string
109
  example: '2024123100010001'
110
  description: Application ID
111
  status:
112
  type: string
113
  enum:
114
  - "ApplicationInProcessAP"
115
  - "ApplicationInProcessAM"
116
  - "Accepted"
117
  - "StatementInProcessTB"
118
  - "StatementReturnedForRevisionAM"
119
  - "StatementFixed"
120
  - "CancelRequestInProcessAP"
121
  - "CancelRequestInProcessAM"
122
  - "Canceled"
123
  hasMore:
124
  type: boolean
125
  example: false
126
  description: Whether there are more than 1,000 application IDs. If true, please send a request again by narrowing down the conditions such as application date, statement fixing date, and status.
127
  post:
128
  summary: Register for your creation/redemption application
129
  description: |
130
  Fill in the information required to apply for creation/redemption and register your application.
131
 
132
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
133
  The value set depends on `clearingType` of the issue being applied for.
134
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
135
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
136
  operationId: registerApplication
137
  tags:
138
  - applications
139
  requestBody:
140
  required: true
141
  content:
142
  application/json:
143
  schema:
144
  $ref: '#/components/schemas/Application'
145
  responses:
146
  '201':
147
  description: Created
148
  content:
149
  application/json:
150
  schema:
151
  type: object
152
  properties:
153
  applicationId:
154
  type: string
155
  example: '2024123100010001'
156
  '400':
157
  description: "Bad Request"
158
  content:
159
  application/json:
160
  schema:
161
  type: object
162
  properties:
163
  message:
164
  type: string
165
  enum:
166
  - ETF code or AP code is incorrect.
167
  - Application date is incorrect.
168
  - Cut-off time for this ETF fund has already elapsed.
169
  - Number of shares is incorrect.
170
  - The number of digits in 'numberOfShares' is exceeded.
171
  - Number of shares must be an integer multiple of the order unit.
172
  - Number of shares must be exceeded the minimum.
173
+ - Number of shares must be an integer multiple of the trading unit. The trading unit is {trading unit}.
174
  - This issue can only be applied with clearing.
175
  - This issue can only be applied with non-clearing.
176
  example: 'ETF code or AP code is incorrect.'
177
  '403':
178
  description: 'Forbidden'
179
  content:
180
  application/json:
181
  schema:
182
  type: object
183
  properties:
184
  message:
185
  type: string
186
  example: 'You are not allowed to register an application.'
187
  /applications/{applicationId}:
188
  get:
189
  summary: Get detailed application information
190
  description: 'Specify the applicationId to get details of the applications that the user has permission to view.'
191
  parameters:
192
  - $ref: '#/components/parameters/applicationId'
193
  operationId: getApplicationDetails
194
  tags:
195
  - applications
196
  responses:
197
  '200':
198
  description: Success operation
199
  content:
200
  application/json:
201
  schema:
202
  $ref: '#/components/schemas/ApplicationInfo'
203
  '403':
204
  description: 'Forbidden'
205
  content:
206
  application/json:
207
  schema:
208
  type: object
209
  properties:
210
  message:
211
  type: string
212
  example: 'You are not allowed to access this application.'
213
  /applications/{applicationId}/approve:
214
  put:
215
  summary: Approve a creation/redemption application
216
  parameters:
217
  - $ref: '#/components/parameters/applicationId'
218
  description: 'Approve an application from market makers.'
219
  operationId: approveApplication
220
  tags:
221
  - applications
222
  responses:
223
  '200':
224
  description: Success operation
225
  '400':
226
  description: 'Bad Request'
227
  content:
228
  application/json:
229
  schema:
230
  type: object
231
  properties:
232
  message:
233
  type: string
234
  enum:
235
  - This approval is not available for this application ID.
236
  - This application cannot be approved because it has exceeded the cut-off.
237
  example: 'This approval is not available for this application ID.'
238
  '403':
239
  description: 'Forbidden'
240
  content:
241
  application/json:
242
  schema:
243
  type: object
244
  properties:
245
  message:
246
  type: string
247
  example: 'You are not allowed to access this application.'
248
  /applications/{applicationId}/deny:
249
  put:
250
  summary: Deny a creation/redemption application
251
  parameters:
252
  - $ref: '#/components/parameters/applicationId'
253
  description: 'Deny an application from market makers.'
254
  operationId: denyApplication
255
  tags:
256
  - applications
257
  responses:
258
  '200':
259
  description: Success operation
260
  '400':
261
  description: 'Bad Request'
262
  content:
263
  application/json:
264
  schema:
265
  type: object
266
  properties:
267
  message:
268
  type: string
269
  example: 'This denial is not available for this application ID.'
270
  '403':
271
  description: 'Forbidden'
272
  content:
273
  application/json:
274
  schema:
275
  type: object
276
  properties:
277
  message:
278
  type: string
279
  example: 'You are not allowed to access this application.'
280
  /applications/{applicationId}/approveCancellationRequest:
281
  put:
282
  summary: Approve a cancellation request
283
  parameters:
284
  - $ref: '#/components/parameters/applicationId'
285
  description: 'Approve a cancellation request from market makers.'
286
  operationId: approveCancellationRequest
287
  tags:
288
  - applications
289
  responses:
290
  '200':
291
  description: Success operation
292
  '400':
293
  description: 'Bad Request'
294
  content:
295
  application/json:
296
  schema:
297
  type: object
298
  properties:
299
  message:
300
  type: string
301
  example: 'This approval is not available for this application ID.'
302
  '403':
303
  description: 'Forbidden'
304
  content:
305
  application/json:
306
  schema:
307
  type: object
308
  properties:
309
  message:
310
  type: string
311
  example: 'You are not allowed to access this application.'
312
  /applications/{applicationId}/denyCancellationRequest:
313
  put:
314
  summary: Deny a cancellation request
315
  parameters:
316
  - $ref: '#/components/parameters/applicationId'
317
  description: 'Deny a cancellation request from market makers.'
318
  operationId: denyCancellationRequest
319
  tags:
320
  - applications
321
  responses:
322
  '200':
323
  description: Success operation
324
  '400':
325
  description: 'Bad Request'
326
  content:
327
  application/json:
328
  schema:
329
  type: object
330
  properties:
331
  message:
332
  type: string
333
  example: 'This denial is not available for this application ID.'
334
  '403':
335
  description: 'Forbidden'
336
  content:
337
  application/json:
338
  schema:
339
  type: object
340
  properties:
341
  message:
342
  type: string
343
  example: 'You are not allowed to access this application.'
344
  /applications/{applicationId}/cancellationRequest:
345
  put:
346
  summary: Request APs to cancel an application
347
  parameters:
348
  - $ref: '#/components/parameters/applicationId'
349
  description: 'Request APs to cancel a registered application.'
350
  operationId: cancellationRequest
351
  tags:
352
  - applications
353
  responses:
354
  '200':
355
  description: Success operation
356
  '400':
357
  description: 'Bad Request'
358
  content:
359
  application/json:
360
  schema:
361
  type: object
362
  properties:
363
  message:
364
  type: string
365
  example: 'Cancellation is not available for this application ID.'
366
  '403':
367
  description: 'Forbidden'
368
  content:
369
  application/json:
370
  schema:
371
  type: object
372
  properties:
373
  message:
374
  type: string
375
  example: 'You are not allowed to access this application.'
376
  /statements/{applicationId}:
377
  get:
378
  summary: Get statement data
379
  description: Get statement data for each applicationId.
380
  operationId: getStatementjson
381
  parameters:
382
  - $ref: '#/components/parameters/applicationId'
383
  tags:
384
  - applications
385
  responses:
386
  '200':
387
  description: Success operation
388
  content:
389
  application/json:
390
  schema:
391
  $ref: '#/components/schemas/Statements'
392
  '400':
393
  description: 'Bad Request'
394
  content:
395
  application/json:
396
  schema:
397
  type: object
398
  properties:
399
  message:
400
  type: string
401
  example: 'This request is not available for this application ID.'
402
  '403':
403
  description: 'Forbidden'
404
  content:
405
  application/json:
406
  schema:
407
  type: object
408
  properties:
409
  message:
410
  type: string
411
  example: 'You are not allowed to access this application.'
412
  /issues:
413
  get:
414
  summary: Get basic information of each issue
415
  description: Get basic information of each issue.
416
  operationId: getIssueInfojson
417
  tags:
418
  - information
419
  responses:
420
  '200':
421
  description: Success operation
422
  content:
423
  application/json:
424
  schema:
425
  $ref: '#/components/schemas/Issues'
426
  /issues/blackout:
427
  get:
428
  summary: Get blackout dates of each issue
429
  description: Get blackout dates of each issue.
430
  operationId: getBlackoutCalendarjson
431
  tags:
432
  - information
433
  responses:
434
  '200':
435
  description: Success operation
436
  content:
437
  application/json:
438
  schema:
439
  type: object
440
  properties:
441
  issues:
442
  type: array
443
  items:
444
  $ref: '#/components/schemas/Blackout'
445
  security:
446
  - ApiKeyAuth: []
447
  components:
448
  securitySchemes:
449
  ApiKeyAuth:
450
  type: apiKey
451
  in: header
452
  name: X-API-KEY
453
  schemas:
454
  Application:
455
  type: object
456
  properties:
457
  applicationDate:
458
  type: string
459
  format: date
460
  description: Application date
461
  example: '2025-04-15'
462
  apCode:
463
  type: string
464
  description: AP code. 5-digit number.
465
  example: '12345'
466
  etfCode:
467
  type: string
468
  description: ETFfund code. 5-digit alphanumeric character.
469
  example: '12340'
470
  creationOrRedemption:
471
  type: string
472
  description: Specify Creation or Redemption. 'C':Creation 'R':Redemption
473
  example: 'C'
474
  numberOfShares:
475
  type: integer
476
  description: Number of shares.
477
  example: 10000
478
  format: int32
479
  pcfNumber:
480
  type: string
481
  description: PCF number. 16-digit alphanumeric character.
482
  example: '1234567890123456'
483
  notes:
484
  type: string
485
  description: Notes from market makers to APs.
486
  example: 'string'
487
  isClearing:
488
  type: boolean
489
  description: |
490
  Cleared by JSCC or non-cleared. false:non-cleared true:cleared.
491
 
492
  If `isClearing` is not specified, the CredNex system will automatically complete the value of `isClearing` for the application.
493
  The value set depends on `clearingType` of the issue being applied for.
494
  If the `clearingType` in each issue's basic information is Clearing or Selectable, `isClearing` will be set to true and the application will be registered as cleared by JSCC.
495
  If the `clearingType` is Non-Clearing, `isClearing` will be set to false and the application will be registered as non-cleared by JSCC.
496
  example: true
497
  required:
498
  - applicationDate
499
  - apCode
500
  - etfCode
501
  - creationOrRedemption
502
  - numberOfShares
503
  ApplicationInfo:
504
  allOf:
505
  - $ref: '#/components/schemas/Application'
506
  properties:
507
  status:
508
  type: string
509
  enum:
510
  - "ApplicationInProcessAP"
511
  - "ApplicationInProcessAM"
512
  - "Accepted"
513
  - "StatementInProcessTB"
514
  - "StatementReturnedForRevisionAM"
515
  - "StatementFixed"
516
  - "CancelRequestInProcessAP"
517
  - "CancelRequestInProcessAM"
518
  - "Canceled"
519
  example: "ApplicationInProcessAP"
520
  description: Application status at the time.
521
  # codesOfTreasuryStock:
522
  # type: array
523
  # items:
524
  # type: string
525
  # example: '12340'
526
  # description: 5-digit code of treasury stock.
527
  jasdecAccountInformation:
528
  type: string
529
  example: '1234567'
530
  description: JASDEC account information. 7-digit number.
531
  navPerShareCalculationDate:
532
  type: string
533
  format: date
534
  example: '2025-05-29'
535
  description: NAV per share calculation date.
536
  statementFixingDate:
537
  type: string
538
  format: date
539
  example: '2025-05-29'
540
  description: Statement fixing date.
541
  trustEstablishmentOrCancellationDate:
542
  type: string
543
  format: date
544
  example: '2025-05-30'
545
  description: Trust establishment or cancellation date.
546
  settlementDate:
547
  type: string
548
  format: date
549
  example: '2025-05-31'
550
  description: Settlement date.
551
  dvpClearingPrice:
552
  type: string
553
  example: '12345678901234.1234'
554
  description: |
555
  DVP clearing price. Used only if an application is in cash ETF and cleared.
556
  Issues:
557
  type: object
558
  properties:
559
  issues:
560
  type: array
561
  items:
562
  type: object
563
  properties:
564
  etfCode:
565
  type: string
566
  description: ETF fund code. 5-digit alphanumeric character.
567
  example: '12340'
568
  inKindOrInCash:
569
  type: string
570
  description: Specify in-kind or in-cash.
571
  example: 'CashCreationCashRedemption'
572
  enum:
573
  - CashCreationCashRedemption
574
  - InKindCreationInKindRedemption
575
  - CashCreationInKindRedemption
576
  etfNameJa:
577
  type: string
578
  description: ETF fund name in Japanese.
579
  example: 'XXX ファンド'
580
  etfNameEn:
581
  type: string
582
  description: ETF fund name in English.
583
  example: 'XXX fund'
584
  cutoffTimeExcludingTreasuryStock:
585
  type: string
586
  description: Cut-off time (JST) for cases where the treasury stock of AP is not included in the basket. All cut-off time for in cash ETF funds are placed in this field.
587
  example: '15:30'
588
  creation:
589
  type: object
590
  properties:
591
  clearingType:
592
  type: string
593
  enum:
594
  - Clearing
595
  - Non-Clearing
596
  - Selectable
597
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
598
  example: 'Clearing'
599
  schedule:
600
  type: object
601
  properties:
602
  clearing:
603
  $ref: "#/components/schemas/CreationSchedule"
604
  nonClearing:
605
  $ref: "#/components/schemas/CreationSchedule"
606
  example:
607
  clearing:
608
  navPerShareCalculationDate: 0
609
  statementFixingDate: 1
610
  trustEstablishmentDate: 2
611
  settlementDate: 2
612
  nonClearing: null
613
  orderUnit:
614
  type: integer
615
  description: Order unit in case of creation. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
616
  example: 10000
617
  minimumNumberOfShares:
618
  type: integer
619
  description: Minimum number of shares in case of creation. If it is 30000, applicants can request in quantities of 30,000 or more.
620
  example: 30000
621
  redemption:
622
  type: object
623
  properties:
624
  clearingType:
625
  type: string
626
  enum:
627
  - Clearing
628
  - Non-Clearing
629
  - Selectable
630
  description: It means whether this issue can be cleared by JSCC or not. For issues that are selectable, applicants can choose whether or not to cleared by JSCC when registering their application.
631
  example: 'Selectable'
632
  schedule:
633
  type: object
634
  properties:
635
  clearing:
636
  $ref: "#/components/schemas/RedemptionSchedule"
637
  nonClearing:
638
  $ref: "#/components/schemas/RedemptionSchedule"
639
  example:
640
  clearing:
641
  navPerShareCalculationDate: 0
642
  statementFixingDate: 1
643
  trustCancellationDate: 2
644
  settlementDate: 2
645
  nonClearing:
646
  navPerShareCalculationDate: 0
647
  statementFixingDate: 1
648
  trustCancellationDate: 2
649
  settlementDate: 2
650
  orderUnit:
651
  type: integer
652
  description: Order unit in case of redemption. If it is 10000, applicants can only request for an integer multiple of 10,000 as number of shares.
653
  example: 10000
654
  minimumNumberOfShares:
655
  type: integer
656
  description: Minimum number of shares in case of redemption. If it is 30000, applicants can request in quantities of 30,000 or more.
657
  example: 30000
658
  earlyRedemptionClause:
659
  type: integer
660
  description: The number of early redemption shares specified in the terms and conditions of an investment trust for each fund. This is an optional field.
661
  example: 100000
662
  issuersOptionalFundCode:
663
  type: string
664
  description: Fund code used by the issuer to identify the fund internally. This is an optional field.
665
  example: 'ABCD1234'
666
  isinCode:
667
  type: string
668
  description: ISIN code. 12-digit alphanumeric character.
669
  example: 'JP1234567890'
670
  amCode:
671
  type: string
672
  description: AM code. 5-digit number.
673
  example: '00123'
674
  amNameJa:
675
  type: string
676
  description: AM name in Japanese.
677
  example: 'XXX アセットマネジメント'
678
  amNameEn:
679
  type: string
680
  description: AM name in English.
681
  example: 'XXX Asset Management'
682
  tbCode:
683
  type: string
684
  description: TB code. 5-digit number.
685
  example: '00001'
686
  tbNameJa:
687
  type: string
688
  description: TB name in Japanese.
689
  example: 'XXX 信託銀行'
690
  tbNameEn:
691
  type: string
692
  description: TB name in English.
693
  example: 'XXX Trust Bank Co., Ltd.'
694
  handlingPeriodFrom:
695
  type: string
696
  description: Start date of available period for handling.
697
  example: '2024-12-03'
698
  handlingPeriodTo:
699
  type: string
700
  description: End date of available period for handling. If it is null, the end date is undecided.
701
  example: '2025-09-21'
702
  DateList:
703
  type: array
704
  items:
705
  type: string
706
  format: date
707
  example: '1992-12-02'
708
  Blackout:
709
  type: object
710
  properties:
711
  etfCode:
712
  type: string
713
  example: '12340'
714
  creationBlackoutDates:
715
  type: array
716
  items:
717
  type: string
718
  format: date
719
  example: '1992-12-02'
720
  redemptionBlackoutDates:
721
  type: array
722
  items:
723
  type: string
724
  format: date
725
  example: '1992-12-02'
726
 
727
  Statements:
728
  type: object
729
  properties:
730
  applicationId:
731
  type: string
732
  example: '2024123100010001'
733
  description: Application ID
734
  pcfNumber:
735
  type: string
736
  example: '1234567890123456'
737
  description: PCF number. 16-digit alphanumeric character.
738
  amCode:
739
  type: string
740
  example: '00123'
741
  description: AM code. 5-digit number.
742
  amNameJa:
743
  type: string
744
  example: 'XXX アセットマネジメント'
745
  description: AM name in Japanese.
746
  amNameEn:
747
  type: string
748
  example: 'XXX Asset Management'
749
  description: AM name in English.
750
  userId:
751
  type: string
752
  example: 'XXX@crednex.co.jp'
753
  default: User ID that registered this statement as AM
754
  apCode:
755
  type: string
756
  example: '00012'
757
  description: AP code. 5-digit number.
758
  apNameJa:
759
  type: string
760
  example: 'XXX 証券'
761
  description: AP Name in Japanese.
762
  apNameEn:
763
  type: string
764
  example: 'XXX Securities Co., Ltd.'
765
  description: AP Name in English.
766
  etfCode:
767
  type: string
768
  example: '12340'
769
  description: ETF fund code. 5-digit alphanumeric character.
770
  etfISINCode:
771
  type: string
772
  example: 'JP0000000000'
773
  description: ISIN code. 10-digit number.
774
  etfNameJa:
775
  type: string
776
  example: 'XXX ファンド'
777
  description: ETF fund name in Japanese.
778
  etfNameEn:
779
  type: string
780
  example: 'XXX fund'
781
  description: ETF fund name in English.
782
  creationOrRedemption:
783
  type: string
784
  example: 'C'
785
  description: Specify Creation or Redmption. 'C':Creation 'R':Redemption
786
  tbCode:
787
  type: string
788
  example: '00001'
789
  description: TB code. 5-digit number.
790
  tbNameJa:
791
  type: string
792
  example: 'XXX 信託銀行'
793
  description: TB name in Japanese.
794
  tbNameEn:
795
  type: string
796
  example: 'XXX Trust Bank Co., Ltd.'
797
  description: TB name in English.
798
  navPerShareCalculationDate:
799
  type: string
800
  format: date
801
  example: '2025-05-29'
802
  description: NAV per share calculation date.
803
  statementFixingDate:
804
  type: string
805
  format: date
806
  example: '2025-05-29'
807
  description: Statement fixing date.
808
  settlementDate:
809
  type: string
810
  format: date
811
  example: '2025-05-31'
812
  description: Settlement date.
813
  trustEstablishmentOrCancellationDate:
814
  type: string
815
  format: date
816
  example: '2025-05-30'
817
  description: Trust establishment or cancellation date.
818
  etfNavPerShare:
819
  type: string
820
  example: '12345678901234.1234'
821
  description: ETF nav per share.
822
  etfPurchaseOrCancellationPrice:
823
  type: string
824
  example: '12345678901234.1234'
825
  description: ETF purchase or cancellation price.
826
  numberOfShares:
827
  type: integer
828
  example: 10000
829
  format: int32
830
  description: Number of shares the client ordered.
831
  numberOfSharesOfNewRecordOrScheduledDeletion:
832
  type: integer
833
  example: 123456789012345
834
  format: int64
835
  description: The number of shares of new record or scheduled deletion.
836
  etfNetAssetValue:
837
  type: string
838
  example: '12345678901234.1234'
839
  description: ETF net asset value.
840
  executionCosts:
841
  type: string
842
  description: Execution cost of this creation/redemption for AP.
843
  optionalInputItemName1:
844
  type: string
845
  description: Name of optional item.
846
  totalPaymentAmount:
847
  type: string
848
  example: '123456789012345678'
849
  description: Total payment of this creation/redemption for AP.
850
  optionalInputItemName2:
851
  type: string
852
  optionalInputItemContent2:
853
  type: string
854
  description: Contents of optional item.
855
  optionalInputItemName3:
856
  type: string
857
  optionalInputItemContent3:
858
  type: string
859
  optionalInputItemName4:
860
  type: string
861
  statementType:
862
  type: string
863
  enum:
864
  - 'CreatedByAM'
865
  - 'CreatedByCredNex'
866
  description: |
867
  CreatedByAM: This statement is registered by AM, and transitions to 'StatementFixed' status by the deadline of the statement fixing date.
868
 
869
  CreatedByCredNex: This statement is automatically created by CredNex because the application for the statement transitions to 'Accepted', but does not transition to 'StatementFixed' status by the deadline of the statement fixing date.
870
 
871
  If the application is non-cleared, the return value for this item will be an empty string.
872
  optionalInputItemName5:
873
  type: string
874
  dvpSettlementPrice:
875
  type: string
876
  example: '12345678901234.1234'
877
  description: DVP settlement price calculated on the application date. If the application is non-cleared, the return value for this item will be an empty string.
878
  optionalInputItemName6:
879
  type: string
880
  optionalInputItemContent6:
881
  type: string
882
  optionalInputItemName7:
883
  type: string
884
  optionalInputItemContent7:
885
  type: string
886
  optionalInputItemName8:
887
  type: string
888
  optionalInputItemContent8:
889
  type: string
890
  optionalInputItemName9:
891
  type: string
892
  optionalInputItemContent9:
893
  type: string
894
  optionalInputItemName10:
895
  type: string
896
  optionalInputItemContent10:
897
  type: string
898
  notes:
899
  type: string
900
  description: Notices by AM for AP.
901
  BaseSchedule:
902
  type: object
903
  description: Schedule configuration depends on clearingType. For "Clearing", only clearing.schedule is set and nonClearing.schedule is null. For "Non-Clearing", only nonClearing.schedule is set and clearing.schedule is null. For "Selectable", both clearing.schedule and nonClearing.schedule are set.
904
  nullable: true
905
  properties:
906
  navPerShareCalculationDate:
907
  type: integer
908
  description: NAV per share calculation date. It is counted from the trade date (dayT). If it is '0', T+0 is NAV per share calculation date.
909
  example: 0
910
  statementFixingDate:
911
  type: integer
912
  description: Statement fixing date. It is counted from the trade date (dayT).
913
  example: 1
914
  settlementDate:
915
  type: integer
916
  description: Settlement date. It is counted from the trade date (dayT).
917
  example: 2
918
  CreationSchedule:
919
  allOf:
920
  - $ref: "#/components/schemas/BaseSchedule"
921
  - type: object
922
  properties:
923
  trustEstablishmentDate:
924
  type: integer
925
  description: Trust establishment date in case of creation. It is counted from the trade date (dayT).
926
  example: 2
927
  RedemptionSchedule:
928
  allOf:
929
  - $ref: "#/components/schemas/BaseSchedule"
930
  - type: object
931
  properties:
932
  trustCancellationDate:
933
  type: integer
934
  description: Trust cancellation date in case of redemption. It is counted from the trade date (dayT).
935
  example: 2
936
  parameters:
937
  applicationId:
938
  name: applicationId
939
  in: path
940
  required: true
941
  description: Application ID
942
  schema:
943
  type: string
944
  example: '2024123100010001'
945
  statementFixingDate:
946
  name: statementFixingDate
947
  in: query
948
  required: false
949
  description: Statement fixing date. Default is today (JST).
950
  schema:
951
  type: string
952
  format: date
953
  example: '2025-05-29'
954
  tags:
955
  - name: applications
956
  description: Create/Approve creation/redemption applications
957
  - name: information
958
  description: Get information related to ETF creation/redemption operations