法人番号検索APIのAPI仕様書 https://corporation.teraren.com/

corporation.teraren.com.yml

openapi: 3.0.3
info:
  version: 0.0.2
  title: 法人番号検索API
  description: https://corporation.teraren.com/ にて提供している法人番号検索APIの仕様書
  license:
    name: This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
  contact:
    name: Yuki Matsukura
    url: https://twitter.com/matsubokkuri
servers:
  - url: https://corporation.teraren.com
    description: Production
paths:
  /corporations.json:
    get:
      summary: 法人の一覧を取得
      operationId: getCorporations
      description: Corporationの配列を取得
      tags:
        - Corporation
      parameters:
        - name: page
          in: query
          description: ページ番号
          required: false
          example: 1
          schema:
            type: integer
            format: int32
        - name: s
          in: query
          description: 法人名の部分一致検索
          required: false
          example: 日本郵便
          schema:
            type: string
      responses:
        '200':
          description: A paged array of Corporation
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Corporation'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /corporations/{corporate_number}.json:
    get:
      summary: 法人を取得
      operationId: getCorporation
      description: Corporationを取得
      tags:
        - Corporation
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Corporation'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    parameters:
      - schema:
          type: integer
          default: 1
          minimum: 1
        name: corporate_number
        in: path
        description: 法人番号
        required: true
        example: 1070001005817
  /edinets.json:
    get:
      summary: EDINETコードの一覧を取得
      operationId: getEdinets
      description: Edinetの配列を取得
      tags:
        - EDINET
      parameters:
        - name: page
          in: query
          description: ページ番号
          required: false
          example: 1
          schema:
            type: integer
            format: int32
        - name: s
          in: query
          description: 法人名の部分一致検索
          required: false
          example: 日本郵便
          schema:
            type: string
      responses:
        '200':
          description: A paged array of Edinet
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Edinet'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /edinets/{edinet_code}.json:
    get:
      summary: EDINETを取得
      operationId: getEdinet
      description: Edinetを取得
      tags:
        - EDINET
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Edinet'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    parameters:
      - schema:
          type: string
        name: edinet_code
        in: path
        description: EDINET番号
        required: true
        example: 'E37148'
  /prefectures.json:
    get:
      summary: 都道府県ごとの件数法人件数を取得
      operationId: getCorporationsByPrefecture
      description: PrefectureCountの配列を取得
      tags:
        - Prefecture
      parameters:
        - name: page
          in: query
          description: ページ番号
          required: false
          example: 1
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: A paged array of PrefectureCount
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PrefectureCount'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /prefectures/{prefecture_id}.json:
    get:
      summary: 市区町村ごとの法人件数を取得
      operationId: getCorporationCountByArea
      description: AreaCountを取得
      tags:
        - Prefecture
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AreaCount'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    parameters:
      - schema:
          type: integer
          default: 1
          minimum: 1
          maximum: 47
        name: prefecture_id
        in: path
        description: 都道府県ID
        required: true
        example: 13
components:
  schemas:
    Corporation:
      title: Corporation
      type: object
      xml:
        name: Corporation
      x-tags:
        - Corporation
      description: 法人エンティティ
      properties:
        corporate_number:
          type: integer
          format: int64
        created_at:
          type: string
          example: '2021-10-15T12:13:26.433+09:00'
        updated_at:
          type: string
          format: date-time
          example: '2021-10-15T12:13:26.433+09:00'
        name:
          type: string
          example: 日本郵便株式会社
      required:
        - corporate_number
        - name
    PrefectureCount:
      title: PrefectureCount
      type: object
      xml:
        name: PrefectureCount
      x-tags:
        - Prefecture
      description: 都道府県ごとの法人数
      properties:
        id:
          type: integer
          format: int64
          minimum: 1
          maximum: 47
        name:
          type: string
          description: 都道府県名
          example: '東京都'
        name_k:
          type: string
          description: 都道府県名のカタカナ
          example: 'トウキョウト'
        count:
          type: integer
          format: int32
          example: 100
      required:
        - id
        - count
        - name
        - name_k
    AreaCount:
      title: AreaCount
      type: object
      xml:
        name: AreaCount
      x-tags:
        - Prefecture
      description: 市区町村ごとの法人数
      properties:
        name:
          type: string
          description: 市区町村名
          example: '港区'
        count:
          type: integer
          format: int32
          example: 100
      required:
        - count
        - name
    Edinet:
      title: Edinet
      type: object
      xml:
        name: Edinet
      x-tags:
        - EDINET
      description: EDINET (金融商品取引法に基づく有価証券報告書等の開示書類に関する電子開示システム)
      properties:
        code:
          type: string
          example: "E37148"
          description: EDINETコード
        submitter_type:
          type: string
          example: "内国法人・組合（有価証券報告書等の提出義務者以外）"
          description: 提出者種別
        listed_type:
          type: string
          example: "上場"
          description: 上場区分
        conslidated:
          type: string
          description: "連結濃霧"
          example: 有
        capital:
          type: integer
          example: 18
          description: 資本金
        settlement:
          type: string
          description: 決算日
          example: "12月31日"
        submitter:
          type: string
          example: "株式会社エビス商事"
          description: 提出者
        submitter_en:
          type: string
          example: "Last One Mile Co.,Ltd."
          description: 提出者(英語)
        submitter_kana:
          type: string
          example: "カブシキカイシャエビスショウジ"
          description: 提出者(英語)
        address:
          type: string
          example: "都城市豊満町９８０番地１"
          description: '住所'
        business_type:
          type: string
          example: "内国法人・組合（有価証券報告書等の提出義務者以外）"
          description: '種別'
        securities_code:
          type: string
          description: 証券コード
          example: "6010701027558"
        corporate_number:
          description: 法人番号
          example: "5350001007871"
          type: string
        created_at:
          type: string
          example: '2021-10-15T12:13:26.433+09:00'
        updated_at:
          type: string
          format: date-time
          example: '2021-10-15T12:13:26.433+09:00'
      required:
        - code
    Pagination:
      title: Pagination
      type: object
      xml:
        name: Pagination
      x-tags:
        - Pagination
      description: ページネーションの情報
      properties:
        current_page:
          type: integer
          format: int64
          description: 現在のページ数
          example: 1
        previous_page:
          type: integer
          format: int64
          nullable: true
          description: 前のページ
          example: null
        next_page:
          type: integer
          format: int64
          description: 次のページ
          example: 2
        limit_value:
          type: integer
          format: int64
          description: 1ページあたりの表示件数
          example: 10
        total_pages:
          type: integer
          format: int64
          description: 全ページ数
          example: 10
        total_count:
          type: integer
          format: int64
          description: 結果件数
          example: 100
      required:
        - current
        - next
        - limit_value
        - pages
        - count
    Error:
      title: Error
      type: object
      description: A standard error object.
      x-tags:
        - common
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      x-examples:
        サーバエラー:
          code: '500'
          message: サーバサイドのエラー