Equity Rank

Equity Rank Friends And Family API

The friends-and-family API from Equity Rank — 4 operation(s) for friends-and-family.

GitHub OpenAPI

Operations 6

POST /api/ff/invites Create Invite #
GET /api/ff/invites List Invites #
GET /api/ff/invite/{code} Preview Invite #
POST /api/ff/redeem/{code} Redeem Invite #
POST /api/ff/feedback Submit Feedback #
GET /api/ff/feedback List Feedback #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/equity-rank-com/openapi/equity-rank-com-friends-and-family-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/equity-rank-com/json-schema/equity-rank-com-invite-admin-schema.json
📊
JSONSchema
https://artifacts.apis.io/equity-rank-com/json-schema/equity-rank-com-feedback-admin-schema.json
📊
JSONSchema
https://artifacts.apis.io/equity-rank-com/json-schema/equity-rank-com-invite-preview-schema.json
📊
JSONSchema
https://artifacts.apis.io/equity-rank-com/json-schema/equity-rank-com-feedback-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/equity-rank-com/json-schema/equity-rank-com-redeem-invite-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/equity-rank-com/json-schema/equity-rank-com-create-invite-request-schema.json

Work with this as data

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/equity-rank-com:equity-rank-com-friends-and-family-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

equity-rank-com-friends-and-family-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Equity Rank Com Friends And Family API
  version: 0.1.0
  description: 'Operations tagged friends-and-family across 2 of this provider''s published API definitions: openapi.json, equity-rank-com-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: friends-and-family
paths:
  /api/ff/invites:
    post:
      tags:
      - friends-and-family
      summary: Create Invite
      description: 'Admin-only: create a new invite code.'
      operationId: create_invite_api_ff_invites_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInviteRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - friends-and-family
      summary: List Invites
      description: 'Admin-only: list recent invites for the /admin/ff dashboard.'
      operationId: list_invites_api_ff_invites_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 100
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InviteAdmin'
                title: Response List Invites Api Ff Invites Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/ff/invite/{code}:
    get:
      tags:
      - friends-and-family
      summary: Preview Invite
      description: 'Public, no-auth: preview an invite by code.


        Used by /invite/:code landing page to render the F&F memo before

        asking the user to sign in + redeem. Does NOT leak created_by_email

        or use counts.'
      operationId: preview_invite_api_ff_invite__code__get
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitePreview'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/ff/redeem/{code}:
    post:
      tags:
      - friends-and-family
      summary: Redeem Invite
      description: 'Authenticated user: redeem an invite code.


        Idempotent in the sense that if the user is already F&F, redemption

        still bumps use_count by 1 (an audit trail of who clicked the link).

        The Supabase admin API call to set app_metadata is fail-soft — if

        the supabase auth call fails, the redemption row is still written

        so the owner can manually backfill via /api/admin/users/{id}/role.'
      operationId: redeem_invite_api_ff_redeem__code__post
      security:
      - HTTPBearer: []
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedeemInviteRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedeemInviteResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/ff/feedback:
    post:
      tags:
      - friends-and-family
      summary: Submit Feedback
      description: 'F&F (or admin): submit feedback.


        Captures user-agent from the request headers as debug context.

        Service layer normalizes ticker to uppercase + validates body length.'
      operationId: submit_feedback_api_ff_feedback_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - friends-and-family
      summary: List Feedback
      description: 'Admin-only: list feedback for /admin/ff dashboard + FF-03 digest.'
      operationId: list_feedback_api_ff_feedback_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 200
          title: Limit
      - name: undigested_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Undigested Only
      - name: unresolved_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Unresolved Only
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FeedbackAdmin'
                title: Response List Feedback Api Ff Feedback Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RedeemInviteRequest:
      properties:
        acknowledgment_displayed:
          type: boolean
          title: Acknowledgment Displayed
          description: MUST be true when the invite has acknowledgment_required=true. Frontend sets this AFTER displaying the F&F memo and capturing user assent.
      type: object
      required:
      - acknowledgment_displayed
      title: RedeemInviteRequest
    FeedbackResponse:
      properties:
        id:
          type: integer
          title: Id
        submitted_at:
          type: string
          title: Submitted At
        received:
          type: boolean
          title: Received
          default: true
        next_steps:
          type: string
          title: Next Steps
          default: Thanks for the feedback — the owner reviews these weekly.
      type: object
      required:
      - id
      - submitted_at
      title: FeedbackResponse
    InvitePreview:
      properties:
        code:
          type: string
          title: Code
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        is_redeemable:
          type: boolean
          title: Is Redeemable
        acknowledgment_required:
          type: boolean
          title: Acknowledgment Required
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
      type: object
      required:
      - code
      - is_redeemable
      - acknowledgment_required
      title: InvitePreview
      description: Public-safe subset of FFInvite — no created_by_email, no internal IDs.
    CreateInviteRequest:
      properties:
        label:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Label
        max_uses:
          type: integer
          maximum: 1000.0
          minimum: 1.0
          title: Max Uses
          default: 1
        acknowledgment_required:
          type: boolean
          title: Acknowledgment Required
          default: true
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
      type: object
      title: CreateInviteRequest
    InviteAdmin:
      properties:
        id:
          type: integer
          title: Id
        code:
          type: string
          title: Code
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        max_uses:
          type: integer
          title: Max Uses
        use_count:
          type: integer
          title: Use Count
        acknowledgment_required:
          type: boolean
          title: Acknowledgment Required
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
        created_by_email:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By Email
        created_at:
          type: string
          title: Created At
        disabled_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Disabled At
        is_redeemable:
          type: boolean
          title: Is Redeemable
      type: object
      required:
      - id
      - code
      - label
      - max_uses
      - use_count
      - acknowledgment_required
      - expires_at
      - created_by_email
      - created_at
      - disabled_at
      - is_redeemable
      title: InviteAdmin
      description: Full invite view for /admin/ff dashboard.
    FeedbackRequest:
      properties:
        body:
          type: string
          maxLength: 8000
          minLength: 3
          title: Body
        surface:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Surface
        ticker:
          anyOf:
          - type: string
            maxLength: 12
          - type: 'null'
          title: Ticker
        rating:
          anyOf:
          - type: integer
            maximum: 5.0
            minimum: 1.0
          - type: 'null'
          title: Rating
      type: object
      required:
      - body
      title: FeedbackRequest
    FeedbackAdmin:
      properties:
        id:
          type: integer
          title: Id
        user_id:
          type: string
          title: User Id
        user_email:
          anyOf:
          - type: string
          - type: 'null'
          title: User Email
        surface:
          anyOf:
          - type: string
          - type: 'null'
          title: Surface
        ticker:
          anyOf:
          - type: string
          - type: 'null'
          title: Ticker
        rating:
          anyOf:
          - type: integer
          - type: 'null'
          title: Rating
        body:
          type: string
          title: Body
        submitted_at:
          type: string
          title: Submitted At
        digested_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Digested At
        resolved_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Resolved At
        resolved_note:
          anyOf:
          - type: string
          - type: 'null'
          title: Resolved Note
      type: object
      required:
      - id
      - user_id
      - user_email
      - surface
      - ticker
      - rating
      - body
      - submitted_at
      - digested_at
      - resolved_at
      - resolved_note
      title: FeedbackAdmin
    RedeemInviteResponse:
      properties:
        redeemed:
          type: boolean
          title: Redeemed
        invite_id:
          type: integer
          title: Invite Id
        user_id:
          type: string
          title: User Id
        next_steps:
          type: string
          title: Next Steps
          default: Sign out and back in to refresh your JWT. Your is_friends_family flag is now set; the paid funnel is bypassed.
      type: object
      required:
      - redeemed
      - invite_id
      - user_id
      title: RedeemInviteResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- equity-rank-com-openapi.yml