GivingService.openapi.json

{"components":{"schemas":{"CategoryBreakdown":{"description":"CategoryBreakdown represents giving activity within a specific cause category.","properties":{"activeCampaigns":{"description":"Number of active campaigns in this category.","format":"int32","type":"integer"},"category":{"description":"Category name (e.g., \"Medical\", \"Disaster Relief\", \"Education\").","type":"string"},"change24h":{"description":"24-hour change in share percentage points.","format":"double","type":"number"},"share":{"description":"Share of total giving activity (0-1).","format":"double","type":"number"},"trending":{"description":"Trending indicator.","type":"boolean"}},"type":"object"},"CryptoGivingSummary":{"description":"CryptoGivingSummary tracks transparent on-chain philanthropy.","properties":{"dailyInflowUsd":{"description":"Total 24h inflow to tracked charity wallets (USD equivalent).","format":"double","type":"number"},"pctOfTotal":{"description":"Percentage of total giving that is on-chain.","format":"double","type":"number"},"topReceivers":{"items":{"description":"Top receiving platforms / DAOs.","type":"string"},"type":"array"},"trackedWallets":{"description":"Number of tracked charity wallets.","format":"int32","type":"integer"},"transactions24h":{"description":"Number of transactions in the last 24 hours.","format":"int32","type":"integer"}},"type":"object"},"Error":{"description":"Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.","properties":{"message":{"description":"Error message (e.g., 'user not found', 'database connection failed')","type":"string"}},"type":"object"},"FieldViolation":{"description":"FieldViolation describes a single validation error for a specific field.","properties":{"description":{"description":"Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')","type":"string"},"field":{"description":"The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')","type":"string"}},"required":["field","description"],"type":"object"},"GetGivingSummaryRequest":{"description":"GetGivingSummaryRequest specifies parameters for retrieving the global giving summary.","properties":{"categoryLimit":{"description":"Number of category breakdowns to include (0 = all).","format":"int32","type":"integer"},"platformLimit":{"description":"Number of platforms to include (0 = all).","format":"int32","type":"integer"}},"type":"object"},"GetGivingSummaryResponse":{"description":"GetGivingSummaryResponse contains the global giving activity summary.","properties":{"summary":{"$ref":"#/components/schemas/GivingSummary"}},"type":"object"},"GivingSummary":{"description":"GivingSummary represents a global overview of personal giving activity across platforms.","properties":{"activityIndex":{"description":"Global giving activity index (0-100 composite score).","format":"double","type":"number"},"categories":{"items":{"$ref":"#/components/schemas/CategoryBreakdown"},"type":"array"},"crypto":{"$ref":"#/components/schemas/CryptoGivingSummary"},"estimatedDailyFlowUsd":{"description":"Estimated daily global giving flow in USD (directional, not precise).. Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"double","type":"number"},"generatedAt":{"description":"Timestamp of the summary generation (ISO 8601).","type":"string"},"institutional":{"$ref":"#/components/schemas/InstitutionalGiving"},"platforms":{"items":{"$ref":"#/components/schemas/PlatformGiving"},"type":"array"},"trend":{"description":"Index trend direction.","type":"string"}},"type":"object"},"InstitutionalGiving":{"description":"InstitutionalGiving tracks large-scale structured philanthropy and ODA.","properties":{"cafDataYear":{"description":"Year of latest CAF data.","format":"int32","type":"integer"},"cafWorldGivingIndex":{"description":"CAF World Giving Index score (latest).","format":"double","type":"number"},"candidGrantsTracked":{"description":"Number of foundation grants tracked (Candid).","format":"int32","type":"integer"},"dataLag":{"description":"Data lag description (e.g., \"Quarterly\", \"Annual\").","type":"string"},"oecdDataYear":{"description":"Year of latest OECD data.","format":"int32","type":"integer"},"oecdOdaAnnualUsdBn":{"description":"Latest OECD ODA total (annual, USD billions).","format":"double","type":"number"}},"type":"object"},"PlatformGiving":{"description":"PlatformGiving represents aggregated giving data from a single crowdfunding platform.","properties":{"activeCampaignsSampled":{"description":"Number of active campaigns being sampled.","format":"int32","type":"integer"},"dailyVolumeUsd":{"description":"Estimated daily donation volume in USD.","format":"double","type":"number"},"dataFreshness":{"description":"Data freshness: \"live\", \"daily\", \"weekly\", \"annual\".","type":"string"},"donationVelocity":{"description":"Average donation velocity (donations per hour).","format":"double","type":"number"},"lastUpdated":{"description":"Last data update timestamp (ISO 8601).","type":"string"},"newCampaigns24h":{"description":"New campaigns created in the last 24 hours.","format":"int32","type":"integer"},"platform":{"description":"Platform name (e.g., \"GoFundMe\", \"GlobalGiving\", \"JustGiving\").","minLength":1,"type":"string"}},"required":["platform"],"type":"object"},"ValidationError":{"description":"ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.","properties":{"violations":{"description":"List of validation violations","items":{"$ref":"#/components/schemas/FieldViolation"},"type":"array"}},"required":["violations"],"type":"object"}}},"info":{"title":"GivingService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/giving/v1/get-giving-summary":{"get":{"description":"GetGivingSummary retrieves a composite global giving activity index and platform breakdowns.","operationId":"GetGivingSummary","parameters":[{"description":"Number of platforms to include (0 = all).","in":"query","name":"platform_limit","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Number of category breakdowns to include (0 = all).","in":"query","name":"category_limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGivingSummaryResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error response"}},"summary":"GetGivingSummary","tags":["GivingService"]}}}}