Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/getsmileapi:getsmileapi-insights-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Smile Insights API
version: 1.14.0
description: The Smile API provides employment and income data from a single API.
contact:
name: Smile Technology Pte Ltd
url: https://www.getsmileapi.com
email: info@getsmileapi.com
termsOfService: https://www.getsmileapi.com/terms-and-conditions
servers:
- url: https://sandbox.smileapi.io/v1
description: Sandbox
- url: https://open.smileapi.io/v1
description: Production
security:
- basicAuth: []
tags:
- name: Insights
paths:
/insights:
parameters: []
get:
operationId: list-insights
description: List insights from data sources.
summary: List insights
tags:
- Insights
parameters:
- $ref: '#/components/parameters/size'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/userId'
- $ref: '#/components/parameters/sourceId'
responses:
'200':
description: List Insights Response
content:
application/json:
schema:
$ref: '#/components/schemas/InsightListResponse'
examples:
Example:
value:
code: OK
message: Success
requestId: 5b79399a-6852-4234-bb0e-ad472648282d
data:
nextCursor: '1259723474'
items:
- id: insight-123abc456def789abc123def456abc78
cutoffTime: '2022-07-05T10:30:11Z'
features:
incomes_count: 100
incomes_first_income_month_range: 10
metadata:
createdAt: '2021-04-14T09:30:24Z'
sourceId: a-123abc456def789abc123def456abc78
sourceType: ACCOUNT
userId: tenantId-123abc456def789abc123def456abc78
providerId: abccorp
/insights/{id}:
parameters:
- $ref: '#/components/parameters/id'
get:
summary: View Insight
tags:
- Insights
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InsightGetResponse'
examples:
Example:
value:
code: OK
message: Success
requestId: 5b79399a-6852-4234-bb0e-ad472648282d
data:
id: insight-123abc456def789abc123def456abc78
cutoffTime: '2022-07-05T10:30:11Z'
features:
incomes_count: 100
incomes_first_income_month_range: 10
metadata:
createdAt: '2021-04-14T09:30:24Z'
sourceId: a-123abc456def789abc123def456abc78
sourceType: ACCOUNT
userId: tenantId-123abc456def789abc123def456abc78
providerId: abccorp
operationId: get-feature-insight
description: View the user's insight by ID.
components:
parameters:
id:
name: id
in: path
schema:
type: string
minLength: 1
maxLength: 200
description: ID of the specific object in the collection.
required: true
userId:
name: userId
in: query
required: false
schema:
type: string
description: Filter to those associated with a particular user ID.
cursor:
name: cursor
in: query
required: false
schema:
type: string
description: Uses the filter values of the previous page to determine the next set of items.
sourceId:
name: sourceId
in: query
required: false
schema:
type: string
description: Filter to those associated with a particular source ID. If we query the link account data, the sourceId is the accountId, If we query the archive data, then the sourceId is the archiveId
size:
name: size
in: query
schema:
type: integer
example: 50
minimum: 1
maximum: 150
default: 10
description: The number of objects you want returned in a collection.
schemas:
ObjectReferenceMetadata:
title: Reference Metadata
type: object
description: Metadata related to account-specific data
properties:
itemCreatedAt:
$ref: '#/components/schemas/RefDateTime'
createdAt:
$ref: '#/components/schemas/RefDateTime'
accountId:
type: string
deprecated: true
description: The accountId of this object
sourceId:
type: string
description: The ACCOUNT or ARCHIVE ID associated with this object
sourceType:
$ref: '#/components/schemas/RefSourceType'
userId:
type: string
description: The user ID associated with this object
providerId:
type: string
description: The provider ID associated with this object
required:
- createdAt
- itemCreatedAt
- sourceId
- sourceType
- userId
- providerId
CommonResponse:
title: CommonResponse
type: object
required:
- code
- requestId
properties:
code:
$ref: '#/components/schemas/ObjectMetadataRefCode'
message:
$ref: '#/components/schemas/ObjectMetadataRefMessage'
requestId:
$ref: '#/components/schemas/ObjectMetadataRefRequestID'
description: ''
Insight:
title: Insight
type: object
allOf:
- $ref: '#/components/schemas/InsightPayload'
- properties:
metadata:
$ref: '#/components/schemas/ObjectReferenceMetadata'
ObjectNextCursor:
title: ObjectNextCursor
type: string
example: '1259723474'
description: The next cursor value that can be used in the following query.
x-internal: false
InsightPayload:
type: object
required:
- id
- cutoffTime
- features
properties:
id:
type: string
example: insight-123456789012345678901234567890
cutoffTime:
type: string
title: Cutoff time for feature calculations.
format: date-time
example: '2021-04-14T09:30:24Z'
description: Date and time
features:
$ref: '#/components/schemas/ObjectFeature'
ObjectFeature:
type: object
properties:
incomes_count:
type: integer
example: 9
description: The quantity of the estimated incomes
incomes_first_income_month_range:
type: integer
example: -999
description: Calculate the interval from the first income record time to the current time by month
incomes_missing_month_max:
type: integer
example: -999
description: From all estimated incomes, calculate the number of months between the last payment month and the next payment month, and then take the maximum value
incomes_missing_month_count:
type: integer
example: -999
description: From all estimated incomes, calculate the months diff between current income month and the before income month, and count if the diff > 1
incomes_amount_sum:
type: number
example: -999
description: From all estimated incomes, calculate the total of the amount
incomes_amount_average:
type: number
example: 1100
description: From all estimated incomes, calculate the average amount of the total amount
incomes_amount_min:
type: number
example: 1000
description: From all estimated incomes, get the minimum amount
incomes_amount_max:
type: number
example: 1200
description: From all estimated incomes, get the maximum amount
incomes_amount_median:
type: number
example: 1200
description: From all estimated incomes, get the median amount
incomes_amount_std:
type: number
example: 1000
description: From all estimated incomes, get the median amount
incomes_last3_months_amount_sum:
type: number
example: 6000
description: From all estimated incomes in last 3 months, calculate the total of the amount
incomes_last3_months_amount_average:
type: number
example: 1100
description: From all estimated incomes in last 3 months, calculate the average amount of the total amount
incomes_last3_months_amount_min:
type: number
example: 1000
description: From all estimated incomes in last 3 months, get the minimum amount
incomes_last3_months_amount_max:
type: number
example: 1200
description: From all estimated incomes in last 3 months, get the maximum amount
incomes_last3_months_amount_median:
type: number
example: 1200
description: From all estimated incomes in last 3 months, get the median amount
incomes_last3_months_amount_std:
type: number
example: 1000
description: From all estimated incomes in last 3 months, get the standard deviation of the amount
incomes_last6_months_amount_sum:
type: number
example: 6000
description: From all estimated incomes in last 6 months, calculate the total of the amount
incomes_last6_months_amount_average:
type: number
example: 1100
description: From all estimated incomes in last 6 months, calculate the average amount of the total amount
incomes_last6_months_amount_min:
type: number
example: 1000
description: From all estimated incomes in last 6 months, get the minimum amount
incomes_last6_months_amount_max:
type: number
example: 1200
description: From all estimated incomes in last 6 months, get the maximum amount
incomes_last6_months_amount_median:
type: number
example: 1200
description: From all estimated incomes in last 6 months, get the median amount
incomes_last6_months_amount_std:
type: number
example: 1000
description: From all estimated incomes in last 6 months, get the standard deviation of the amount
incomes_last9_months_amount_sum:
type: number
example: 6000
description: From all estimated incomes in last 9 months, calculate the total of the amount
incomes_last9_months_amount_average:
type: number
example: 1100
description: From all estimated incomes in last 9 months, calculate the average amount of the total amount
incomes_last9_months_amount_min:
type: number
example: 1000
description: From all estimated incomes in last 9 months, get the minimum amount
incomes_last9_months_amount_max:
type: number
example: 1200
description: From all estimated incomes in last 9 months, get the maximum amount
incomes_last9_months_amount_median:
type: number
example: 1200
description: From all estimated incomes in last 9 months, get the median amount
incomes_last9_months_amount_std:
type: number
example: 1000
description: From all estimated incomes in last 9 months, get the standard deviation of the amount
incomes_last12_months_amount_sum:
type: number
example: 6000
description: From all estimated incomes in last 12 months, calculate the total of the amount
incomes_last12_months_amount_average:
type: number
example: 1100
description: From all estimated incomes in last 12 months, calculate the average amount of the total amount
incomes_last12_months_amount_min:
type: number
example: 1000
description: From all estimated incomes in last 12 months, get the minimum amount
incomes_last12_months_amount_max:
type: number
example: 1200
description: From all estimated incomes in last 12 months, get the maximum amount
incomes_last12_months_amount_median:
type: number
example: 1200
description: From all estimated incomes in last 12 months, get the median amount
incomes_last12_months_amount_std:
type: number
example: 1000
description: From all estimated incomes in last 12 months, get the standard deviation of the amount
incomes_last18_months_amount_sum:
type: number
example: 6000
description: From all estimated incomes in last 18 months, calculate the total of the amount
incomes_last18_months_amount_average:
type: number
example: 1100
description: From all estimated incomes in last 18 months, calculate the average amount of the total amount
incomes_last18_months_amount_min:
type: number
example: 1000
description: From all estimated incomes in last 18 months, get the minimum amount
incomes_last18_months_amount_max:
type: number
example: 1200
description: From all estimated incomes in last 18 months, get the maximum amount
incomes_last18_months_amount_median:
type: number
example: 1200
description: From all estimated incomes in last 18 months, get the median amount
incomes_last18_months_amount_std:
type: number
example: 1000
description: From all estimated incomes in last 18 months, get the standard deviation of the amount
incomes_last18_months_max_amount_count:
type: number
example: 1000
description: From all estimated incomes in last 18 months, find the maximum amount, and count the number of monthly income equal to the maximum amount
incomes_starting_amount:
type: number
example: 1000
description: the estimated income from when the user has started earning income
incomes_current_amount:
type: number
example: 1000
description: the amount from the latetest one record
incomes_latest_growth:
type: number
example: 1000
description: For the latetest one record, calculate the growth of income from the same month last year
liabilities_loan_count:
type: integer
example: 1000
description: For the latetest one record, calculate the count of records
liabilities_loan_amount_min:
type: number
example: 1000
description: From all liabilities, calculate the minimum of the amount
liabilities_loan_amount_max:
type: number
example: 1000
description: From all liabilities, calculate the maximum of the amount
liabilities_loan_amount_total:
type: number
example: 1000
description: From all liabilities, calculate the total of the amount
liabilities_loan_amount_average:
type: number
example: 1000
description: From all liabilities, calculate the average of the amount
liabilities_loan_amount_std:
type: number
example: 1000
description: From all liabilities, calculate the standard deviation of the amount
liabilities_finished_loan_count:
type: number
example: 1000
description: From all liabilities that outstandingBalance <= 0, calculate the count of the records
liabilities_outstanding_loan_count:
type: integer
example: 10
description: From all liabilities that outstandingBalance > 0, calculate the count of the records
liabilities_outstanding_amount_max:
type: number
example: 1000
description: From all liabilities that outstandingBalance > 0, calculate the count of the records
liabilities_outstanding_amount_total:
type: number
example: 1000
description: From all liabilities that outstandingBalance > 0, calculate the total of the amount
liabilities_outstanding_amount_average:
type: number
example: 1000
description: From all liabilities that outstandingBalance > 0, calculate the average of the amount
liabilities_overdue_loan_count:
type: integer
example: 10
description: From all liabilities that overduePaymentAmount > 0, calculate the count of the records
liabilities_overdue_amount_total:
type: number
example: 1000
description: From all liabilities that overduePaymentAmount > 0, calculate the total of the amount
liabilities_overdue_amount_average:
type: number
example: 1000
description: From all liabilities that overduePaymentAmount > 0, calculate the average of the amount
liabilities_ongoing_amortization_amount_sum:
type: number
example: 1000
description: Sum of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
liabilities_ongoing_amortization_amount_min:
type: number
example: 1000
description: Smallest of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
liabilities_ongoing_amortization_amount_max:
type: number
example: 1000
description: Largest of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
liabilities_ongoing_amortization_amount_average:
type: number
example: 1000
description: Average of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
liabilities_ongoing_amortization_amount_median:
type: number
example: 1000
description: Median of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
liabilities_ongoing_amortization_amount_std:
type: number
example: 1000
description: Standard deviation of all amortization amounts for ongoing/current liabilities (not yet fully paid off)
liabilities_payment_count:
type: number
example: 10
description: Quantity of liability payments made (across all liability records)
liabilities_payment_amount_max:
type: number
example: 1000
description: Largest amount of payments made for liabilities (across all liability records).
liabilities_payment_amount_min:
type: number
example: 1000
description: Smallest amount of payments made for liabilities (across all liability records).
liabilities_payment_amount_median:
type: number
example: 1000
description: Median amount of payments made for liabilities (across all liability records).
liabilities_payment_amount_average:
type: number
example: 1000
description: Average amount of payments made for liabilities (across all liability records).
liabilities_payment_amount_sum:
type: number
example: 1000
description: Total amount of payments made for liabilities (across all liability records).
liabilities_payment_amount_std:
type: number
example: 1000
description: Standard deviation of payments made for liabilities (across all liability records).
employments_current_status:
type: string
example: EMPLOYED
description: 'The user''s current employment status, may be one of: EMPLOYED, GIG (for gig economy workers), or UNEMPLOYED'
employments_employer_count:
type: integer
example: 3
description: Quantity of unique employers
employments_current_tenure:
type: integer
example: 5
description: Quantity of months at current employer
identity_age:
type: integer
example: 30
description: Age of the user based on date of birth
link_days_since_first:
type: integer
example: 130
description: Number of days since the first account connection, if MAW is enabled.
link_days_since_last:
type: integer
example: 2
description: Number of days since the last account connection, if MAW is enabled.
link_day3_count:
type: integer
example: 2
description: Number of tenants this account has connected to in the last 3 days, if MAW is enabled.
link_day7_count:
type: integer
example: 5
description: Number of tenants this account has connected to in the last 7 days, if MAW is enabled.
link_day30_count:
type: integer
example: 8
description: Number of tenants this account has connected to in the last 30 days, if MAW is enabled.
link_day90_count:
type: integer
example: 12
description: Number of tenants this account has connected to in the last 90 days, if MAW is enabled.
link_day180_count:
type: integer
example: 12
description: Number of tenants this account has connected to in the last 180 days, if MAW is enabled.
link_day365_count:
type: integer
example: 12
description: Number of tenants this account has connected to in the last 365 days, if MAW is enabled.
link_day730_count:
type: integer
example: 12
description: Number of tenants this account has connected to in the last 730 days, if MAW is enabled.
RefSourceType:
type:
- string
- 'null'
title: Ref-Source-Type
example: Account
enum:
- ACCOUNT
- UPLOAD
- ARCHIVE
- SOCIAL_SECURITY
description: Source Type
InsightGetResponse:
title: Insight Get Response
type: object
allOf:
- $ref: '#/components/schemas/CommonResponse'
- properties:
data:
$ref: '#/components/schemas/Insight'
ObjectMetadataRefCode:
type: string
title: ObjectMetadataRefCode
description: Request status code
enum:
- OK
- CREATED
- INVALID_CREDENTIALS
- INVALID_PARAMETERS
- INVALID_TOKEN
- UNAUTHORIZED_ACCESS
- MISSING_RESOURCE
- REQUEST_LIMIT_EXCEEDED
- SERVER_ERROR
- UNSUPPORTED_METHOD
- SERVER_UNAVAILABLE
- TIME_LIMIT_EXCEEDED
example: OK
x-internal: false
RefDateTime:
type: string
title: Date and Time string
format: date-time
example: '2021-04-14T09:30:24Z'
description: Date and time
ObjectMetadataRefMessage:
type: string
title: ObjectMetadataRefMessage
description: Message response to the request
example: Success
x-internal: false
ObjectMetadataRefRequestID:
type: string
title: ObjectMetadataRefRequestID
description: Unique ID that is added to the body of every response for easy traceability of the request in our logs.
x-internal: false
example: 5b79399a-6852-4234-bb0e-ad472648282d
InsightListResponse:
title: Insight List Response
type: object
allOf:
- $ref: '#/components/schemas/CommonResponse'
- properties:
data:
type: object
properties:
nextCursor:
$ref: '#/components/schemas/ObjectNextCursor'
items:
type: array
items:
$ref: '#/components/schemas/Insight'
securitySchemes:
basicAuth:
type: http
scheme: basic
x-provenance:
method: searched
source: https://docs.getsmileapi.com/reference
harvested: '2026-10-20'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.getsmileapi.com/reference/create-alpha-blacklist.md
- https://docs.getsmileapi.com/reference/create-alpha-footprint.md
- https://docs.getsmileapi.com/reference/create-alpha-income-estimator.md
- https://docs.getsmileapi.com/reference/create-alpha-maw.md
- https://docs.getsmileapi.com/reference/create-alpha-signal.md
- https://docs.getsmileapi.com/reference/create-and-classify-archive.md
- https://docs.getsmileapi.com/reference/create-archive.md
- https://docs.getsmileapi.com/reference/create-beta-maw2.md
- https://docs.getsmileapi.com/reference/create-beta-maw3.md
- https://docs.getsmileapi.com/reference/create-beta-signal.md
- https://docs.getsmileapi.com/reference/create-beta-signal2.md
- https://docs.getsmileapi.com/reference/create-beta-signal3.md
- https://docs.getsmileapi.com/reference/create-beta-social-security.md
- https://docs.getsmileapi.com/reference/create-consent-template.md
- https://docs.getsmileapi.com/reference/create-invite-template.md
- https://docs.getsmileapi.com/reference/create-invite.md
- https://docs.getsmileapi.com/reference/create-token-1.md
- https://docs.getsmileapi.com/reference/create-user-1.md
- https://docs.getsmileapi.com/reference/create-verification.md
- https://docs.getsmileapi.com/reference/create-webhook.md
- https://docs.getsmileapi.com/reference/delete-account.md
- https://docs.getsmileapi.com/reference/delete-archive.md
- https://docs.getsmileapi.com/reference/delete-consent-template.md
- https://docs.getsmileapi.com/reference/delete-invite-template.md
- https://docs.getsmileapi.com/reference/delete-webhook.md
- https://docs.getsmileapi.com/reference/disable-account-monitor.md
- https://docs.getsmileapi.com/reference/generate-account-export.md
- https://docs.getsmileapi.com/reference/get-account-1.md
- https://docs.getsmileapi.com/reference/get-account-payload.md
- https://docs.getsmileapi.com/reference/get-alpha-blacklist.md
- https://docs.getsmileapi.com/reference/get-alpha-footprint.md
- https://docs.getsmileapi.com/reference/get-alpha-form.md
- https://docs.getsmileapi.com/reference/get-alpha-income-estimator.md
- https://docs.getsmileapi.com/reference/get-alpha-maw.md
- https://docs.getsmileapi.com/reference/get-alpha-signal.md
- https://docs.getsmileapi.com/reference/get-archive.md
- https://docs.getsmileapi.com/reference/get-beta-maw.md
- https://docs.getsmileapi.com/reference/get-beta-signal.md
- https://docs.getsmileapi.com/reference/get-beta-social-security.md
- https://docs.getsmileapi.com/reference/get-contribution.md
- https://docs.getsmileapi.com/reference/get-document-1.md
- https://docs.getsmileapi.com/reference/get-eincomes.md
- https://docs.getsmileapi.com/reference/get-employment-1.md
- https://docs.getsmileapi.com/reference/get-feature-insight.md
- https://docs.getsmileapi.com/reference/get-identity-1.md
- https://docs.getsmileapi.com/reference/get-income-1.md
- https://docs.getsmileapi.com/reference/get-invite-template.md
- https://docs.getsmileapi.com/reference/get-invite.md
- https://docs.getsmileapi.com/reference/get-liabilities.md
- https://docs.getsmileapi.com/reference/get-link.md
- https://docs.getsmileapi.com/reference/get-provider-1.md
- https://docs.getsmileapi.com/reference/get-rating-1.md
- https://docs.getsmileapi.com/reference/get-task.md
- https://docs.getsmileapi.com/reference/get-transaction-1.md
- https://docs.getsmileapi.com/reference/get-user-1.md
- https://docs.getsmileapi.com/reference/get-user-session-payload.md
- https://docs.getsmileapi.com/reference/get-verification.md
- https://docs.getsmileapi.com/reference/get-webhook.md
- https://docs.getsmileapi.com/reference/list-accounts-1.md
- https://docs.getsmileapi.com/reference/list-alpha-blacklists.md
- https://docs.getsmileapi.com/reference/list-alpha-footprints.md
- https://docs.getsmileapi.com/reference/list-alpha-forms.md
- https://docs.getsmileapi.com/reference/list-alpha-income-estimators.md
- https://docs.getsmileapi.com/reference/list-alpha-maws.md
- https://docs.getsmileapi.com/reference/list-alpha-signals.md
- https://docs.getsmileapi.com/reference/list-archives.md
- https://docs.getsmileapi.com/reference/list-beta-maws.md
- https://docs.getsmileapi.com/reference/list-beta-signals.md
- https://docs.getsmileapi.com/reference/list-beta-social-securities.md
- https://docs.getsmileapi.com/reference/list-consent-templates.md
- https://docs.getsmileapi.com/reference/list-contributions.md
- https://docs.getsmileapi.com/reference/list-documents-1.md
- https://docs.getsmileapi.com/reference/list-eincomes.md
- https://docs.getsmileapi.com/reference/list-employments-1.md
- https://docs.getsmileapi.com/reference/list-file-types.md
- https://docs.getsmileapi.com/reference/list-identities-1.md
- https://docs.getsmileapi.com/reference/list-incomes-1.md
- https://docs.getsmileapi.com/reference/list-insights.md
- https://docs.getsmileapi.com/reference/list-invite-log.md
- https://docs.getsmileapi.com/reference/list-invite-templates.md
- https://docs.getsmileapi.com/reference/list-invites.md
- https://docs.getsmileapi.com/reference/list-liabilities.md
- https://docs.getsmileapi.com/reference/list-links.md
- https://docs.getsmileapi.com/reference/list-providers.md
- https://docs.getsmileapi.com/reference/list-ratings-1.md
- https://docs.getsmileapi.com/reference/list-tasks.md
- https://docs.getsmileapi.com/reference/list-transactions-1.md
- https://docs.getsmileapi.com/reference/list-users-1.md
- https://docs.getsmileapi.com/reference/list-verifications.md
- https://docs.getsmileapi.com/reference/list-webhooks.md
- https://docs.getsmileapi.com/reference/reset-user-session.md
- https://docs.getsmileapi.com/reference/update-invite-template.md
merge:
pages: 92
deduped: 1153
conflicts_kept_first: 0