feat: add license and openapi spec files

.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: monthly
+  - package-ecosystem: "cargo" # See documentation for possible values
+    directories: 
+      - "/"
+      - "/crates/**/"
+    schedule:
+      interval: "weekly"

.github/workflows/api-specs.yml

@@ -0,0 +1,25 @@
+name: API Specs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  format:
+    name: Check Format
+    runs-on: ubuntu-latest
+    steps:
+      - name: No Operation
+        run: echo "This job does nothing."
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: No Operation
+        run: echo "This job does nothing."

.github/workflows/email-check.yml

@@ -0,0 +1,45 @@
+name: Email Address Check
+
+on: [push]
+
+jobs:
+  check-emails:
+    name: Check Commit Emails
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all history for all branches and tags
+
+      - name: Check commit emails
+        run: |
+          # Get all commits in the current branch
+          COMMITS=$(git rev-list HEAD)
+
+          # Initialize error flag
+          ERROR=0
+
+          # Check each commit
+          for commit in $COMMITS; do
+            # Get author and committer emails
+            AUTHOR_EMAIL=$(git log -1 --format='%ae' $commit)
+            COMMITTER_EMAIL=$(git log -1 --format='%ce' $commit)
+            COMMIT_SHA=$(git rev-parse --short $commit)
+
+            if [[ "$AUTHOR_EMAIL" == *"@kraken.com" ]]; then
+              echo "❌ Error: Commit $COMMIT_SHA has author email ($AUTHOR_EMAIL) from @kraken.com domain"
+              ERROR=1
+            fi
+
+            if [[ "$COMMITTER_EMAIL" == *"@kraken.com" ]]; then
+              echo "❌ Error: Commit $COMMIT_SHA has committer email ($COMMITTER_EMAIL) from @kraken.com domain"
+              ERROR=1
+            fi
+          done
+
+          if [ $ERROR -eq 1 ]; then
+            echo "::error::Found commits with @kraken.com email addresses. Please use a different email address."
+            exit 1
+          else
+            echo "✅ No @kraken.com email addresses found in commits."
+          fi

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Payward, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,78 @@
-# api-specs
-Official open-source specifications for the Kraken API, including OpenAPI and AsyncAPI standards.
+# Kraken API Specifications
+
+Official open-source specifications for the Kraken API ecosystem, including OpenAPI 3.0 standards for all Kraken services. For API documentation, visit: https://docs.kraken.com/.
+
+## Overview
+
+This repository contains comprehensive API specifications for Kraken's trading platform and related services. All specifications follow OpenAPI 3.0 standards and are organized by service domain.
+
+## APIs
+
+### Spot Trading REST API (`spot-rest/`)
+Complete specification for Kraken's spot trading REST API, including:
+- **Public endpoints**: Market data, asset information, order books, trades, OHLC data
+- **Private endpoints**: Account management, trading operations, order management, funding
+- **User data**: Account balances, trade history, ledger information
+- **Trading**: Order placement, modification, cancellation, batch operations
+
+### Futures REST API (`futures-rest/`)
+
+Specification for Kraken's futures trading platform:
+- **Authentication**: API authentication endpoints
+- **Charts**: Chart data and market visualization
+- **History**: Historical data and trade records  
+- **Statistics**: Trading statistics and metrics
+- **Trading**: Futures-specific trading operations
+
+### OAuth API (`oauth/`)
+
+OAuth 2.0 authentication and authorization specification:
+- Authorization code flow
+- Token management
+- Scope definitions
+- Client authentication
+
+### OTC API (`otc/`)
+
+Specification for institutional OTC trading:
+- Quote request creation and management
+- Active and historical quotes
+- Client verification
+- Exposure management
+- Trading pair information
+
+### Pay API (`pay/`)
+Kraken Pay service specification:
+- Payment request creation and management
+- Payment transfers
+- Paylink code generation and configuration
+- Payment cancellation
+
+**Main file**: `pay/openapi_v3.yaml`
+
+## Viewing Specifications
+You can view these specifications using any OpenAPI-compatible tool:
+- [Swagger UI](https://swagger.io/tools/swagger-ui/)
+- [Redoc](https://redoc.ly/)
+- [Postman](https://www.postman.com/)
+- [Insomnia](https://insomnia.rest/)
+
+## Authentication
+Most private endpoints require API key authentication. Refer to the [individual service specifications](https://docs.kraken.com/api/docs/guides/global-intro) on our website for detailed authentication requirements and permissions.
+
+## Standards Compliance
+
+- **OpenAPI Version**: 3.0.0 - 3.0.4
+- **Format**: YAML
+- **Validation**: All specifications should pass OpenAPI validation
+- **Documentation**: Comprehensive descriptions for all endpoints, parameters, and schemas
+
+## Support
+
+For questions about these API specifications or the Kraken API:
+- [Kraken API Documentation](https://docs.kraken.com/rest/)
+- [Kraken Support](https://support.kraken.com/)
+
+## License
+
+These specifications are open-source and available for public use in accordance with Kraken's API terms of service.