sochain-com Account API

openapi: 3.2.0
info:
  title: Sochain Com Account API
  version: '3'
  description: 'Operations tagged Account across 3 of this provider''s published API definitions: sochain-com-openapi.json, dev-sochain-com-openapi.json, sochain-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sochain.com/api/v3
- url: https://dev.sochain.com/api/v3
security:
- ApiKey: []
- ApiKeyQuery: []
tags:
- name: Account
paths:
  /support:
    post:
      operationId: contact_support
      tags:
      - Account
      summary: Ask SoChain support for help
      description: A support request about your key's account; a person replies by email. Any key may send one, read-only too, and it's never counted. The account's failed calls and webhook deliveries from the last 24 hours are attached unless include_recent_failures is false. A message containing a key or recovery phrase is refused. Also available as the MCP tool contact_support.
      security:
      - ApiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - message
              properties:
                message:
                  type: string
                  minLength: 10
                  maxLength: 5000
                  description: 'What''s wrong: what happened and what you expected. Include the network, and the address or transaction if it''s about one.'
                topic:
                  type: string
                  enum:
                  - api
                  - webhooks
                  - plans
                  - account
                  - other
                  default: other
                include_recent_failures:
                  type: boolean
                  default: true
      responses:
        '200':
          description: Sent.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - success
                  data:
                    type: object
                    properties:
                      reference:
                        type: string
                        description: Quote it if you write about the same thing again, e.g. SR-4F1A9C2B.
                      reply:
                        type: string
                      attached_failures:
                        type: integer
                      open_incidents:
                        type: array
                        description: What the status page says is wrong right now, if anything.
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                            since:
                              type: integer
                              description: Unix seconds.
                            latest:
                              type:
                              - string
                              - 'null'
        '400':
          description: 'The message is missing, too short or too long, or carries a secret: data.error_message says which.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '413':
          $ref: '#/components/responses/TooLarge'
        '415':
          $ref: '#/components/responses/NotJson'
        '429':
          description: 'Several requests in a short time: up to 10 a day per account.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fail'
      externalDocs:
        url: https://sochain.com/support
    servers:
    - url: https://sochain.com/api/v3
  /account_info:
    get:
      operationId: get_account_info
      tags:
      - Account
      summary: Your plan and usage
      description: Answers without the status/data envelope.
      parameters: []
      responses:
        '200':
          description: Your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
      externalDocs:
        url: https://sochain.com/docs/account_info
    servers:
    - url: https://sochain.com/api/v3
components:
  responses:
    Unauthorized:
      description: An invalid key, no key where one is needed (buckets, webhooks, /account_info), a locked account or expired plan, or both the month's requests and the keyless rate used up. Kept as 401, with this message, for v3 compatibility.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fail'
          example:
            status: fail
            data:
              error_message: API Key invalid, account access expired, or this account's daily request limit has been exhausted.
    TooLarge:
      description: 'A body over the limit: 256 KB where a call carries addresses or transaction IDs, 64 KB otherwise.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fail'
    NotJson:
      description: 'A body that isn''t JSON: send it with Content-Type: application/json.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Fail'
  schemas:
    Fail:
      type: object
      required:
      - status
      - data
      properties:
        status:
          const: fail
        data:
          type: object
          required:
          - error_message
          properties:
            error_message:
              type: string
    AccountInfo:
      type: object
      required:
      - last_login_at
      - plan
      - num_requests_used
      - quota_resets_in_seconds
      description: Answered without the status/data envelope, as it always has been.
      properties:
        last_login_at:
          type:
          - integer
          - 'null'
          description: Last dashboard sign-in (Unix time).
        plan:
          type: object
          required:
          - name
          - max_monthly_requests
          - max_daily_requests
          - current_period_ends_at
          - will_renew_at_period_end
          properties:
            name:
              enum:
              - free
              - hobby
              - starter
              - professional
              - behemoth
            max_monthly_requests:
              type: integer
              description: Your plan’s requests a month. Past it, lookups carry on at the free rate and webhooks and streams pause until the month resets.
            max_daily_requests:
              type: integer
              description: 'Kept for older clients: the monthly number divided by 30. Nothing stops at it.'
            current_period_ends_at:
              type:
              - string
              - 'null'
              format: date-time
              description: End of the paid period (UTC); null on Free.
            will_renew_at_period_end:
              type: boolean
        num_requests_used:
          type: object
          required:
          - today
          - yesterday
          - this_month
          properties:
            today:
              type: integer
              description: 'Counted so far today (UTC): API calls, MCP tool calls and webhook notifications.'
            yesterday:
              type: integer
              description: The same count for yesterday.
            this_month:
              type: integer
              description: Requests counted this calendar month (UTC).
        quota_resets_in_seconds:
          type: integer
          description: Seconds until the month’s count resets (the 1st, 00:00 UTC).
        key:
          type: object
          description: The key this request used.
          properties:
            name:
              type: string
              description: Its name on the dashboard.
            access:
              enum:
              - full
              - read_only
              description: read_only keys get 403 on any change to webhooks or buckets.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-KEY
      description: Your key, from the dashboard.
    ApiKeyQuery:
      type: apiKey
      in: query
      name: api_key
      description: Your key as a URL parameter, for lookups (GET) from tools that can't send a header, such as spreadsheets. Best a read-only key.
x-refined-from:
- sochain-com-openapi.json
- dev-sochain-com-openapi.json
- sochain-com-openapi.json