API Reference

This is reference documentation for all methods exposed by the Kiva API.

GET /journal_entries/:id/comments

Returns comments for a specified journal entry.

Example

http://api.kivaws.org/v1/journal_entries/28342/comments.json

Parameters

id(number)
Required. The ID number of the journal entry for which you want comments.
page(number)
The page position of results to return.
  • Default: 1
app_id(string)
A unique developer-defined Application ID, usually in reverse DNS notation.

Response

  comment – HTML , JSON , XML

Status

  Production

GET /journal_entries/search

Sort and filter all journal entries based on multiple criteria.

Example

http://api.kivaws.org/v1/journal_entries/search.json

Parameters

partner(list of strings)
If provided, filters results to only those having partners in this list.
sort_by(string)
The order by which to return the results.
  • One of: newest, oldest, recommendation_count, comment_count
  • Default: newest
q(string)
A query string used to match journal entries’ content.
page(number)
The page position of results to return.
  • Default: 1
app_id(string)
The application id in reverse DNS notation.
    ids_only(string)
    Return IDs only to make the return object smaller.
    • One of: true, false
    • Default: false

    Response

      journal_entry – HTML , JSON , XML

    Status

      Production

    GET /lenders/:lender_ids

    Retrieves detail for multiple lenders.

    Example

    http://api.kivaws.org/v1/lenders/matt.json

    Parameters

    lender_ids(list of strings)
    Required. A list of Lender IDs for which to return details.
    • Max list items: 50
    app_id(string)
    The application id in reverse DNS notation.

      Response

        lender_detail – HTML , JSON , XML

      Status

        Production

      GET /lenders/:lender_id/loans

      Returns loans belonging to a particular lender.

      Example

      http://api.kivaws.org/v1/lenders/jeremy/loans.json

      Parameters

      lender_id(string)
      Required. The Lender ID for which to return loans.
        page(number)
        The page position of results to return.
        • Default: 1
        sort_by(string)
        The order by which to sort results.
        • One of: oldest, newest
        • Default: newest
        app_id(string)
        The application id in reverse DNS notation.
          ids_only(string)
          Return IDs only to make the return object smaller.
          • One of: true, false
          • Default: false

          Response

            loan_listing – HTML , JSON , XML , RSS

          Status

            Production

          GET /lenders/:lender_id/teams

          Returns teams that a particular lender is a member of.

          Example

          http://api.kivaws.org/v1/lenders/jeremy/teams.json

          Parameters

          lender_id(string)
          Required. The Lender ID for which to return teams.
            page(number)
            The page position of results to return.
            • Default: 1
            app_id(string)
            The application id in reverse DNS notation.
              ids_only(string)
              Return IDs only to make the return object smaller.
              • One of: true, false
              • Default: false

              Response

                team_detail – HTML , JSON , XML , RSS

              Status

                Production

              GET /lenders/newest

              Returns listings for the lenders who have most recently joined Kiva.

              Example

              http://api.kivaws.org/v1/lenders/newest.json

              Parameters

              page(number)
              The page position of results to return.
              • Default: 1
              app_id(string)
              The application id in reverse DNS notation.
                ids_only(string)
                Return IDs only to make the return object smaller.
                • One of: true, false
                • Default: false

                Response

                  lender_listing – HTML , JSON , XML , RSS

                Status

                  Production

                GET /lenders/search

                Search and sort lender listings based on multiple criteria.

                Example

                http://api.kivaws.org/v1/lenders/search.json

                Parameters

                country_code(list of strings)
                An ISO country code by which to filter results.
                • One of: AF, AL, AM, AZ, BA, BD, BF, BG, BI, BJ, BO, BR, BW, BZ, CD, CG, CI, CL, CM, CO, CR, CV, DO, EC, GE, GH, GT, GZ, HN, HT, ID, IL, IN, IQ, JO, KE, KG, KH, LB, LK, LR, MD, ML, MN, MR, MW, MX, MZ, NA, NG, NI, NP, PA, PE, PG, PH, PK, PS, PY, QS, RW, SL, SN, SO, SR, SV, TD, TG, TH, TJ, TL, TR, TZ, UA, UG, US, VN, VU, WS, XK, YE, ZA, ZM, ZW
                sort_by(string)
                The order by which to sort the results.
                • One of: oldest, newest
                • Default: newest
                q(string)
                A general search query parameter which matches against lenders’ names occupations, whereabouts, and reasons for lending.
                occupation(string)
                If supplied, results are filtered by those that match lenders’ occupation. This parameter is ignored if the "q" parameter is supplied.
                page(number)
                The page position of results to return.
                • Default: 1
                app_id(string)
                The application id in reverse DNS notation.
                  ids_only(string)
                  Return IDs only to make the return object smaller.
                  • One of: true, false
                  • Default: false

                  Response

                    lender_listing – HTML , JSON , XML , RSS

                  Status

                    Production

                  GET /lending_actions/recent

                  Lists the 100 most recent loans made on Kiva by public lenders.

                  This method returns the most recent loan purchases made on Kiva in reverse-chronological order. Loans made by users with private lender profiles are not shown, and there is no way to fetch history beyond the 100 most recent transactions.

                  Example

                  http://api.kivaws.org/v1/lending_actions/recent.json

                  Parameters

                  app_id(string)
                  The application id in reverse DNS notation.

                    Response

                      lending_action – HTML , JSON , XML

                    Status

                      Production

                    GET /loans/:ids

                    Returns detailed information for multiple loans.

                    Detailed loan records include a lot of data beyond the scope of a loan listing, including the list of borrowers, loan terms, and recorded payments.

                    Example

                    http://api.kivaws.org/v1/loans/2930.json

                    Parameters

                    ids(list of numbers)
                    Required. A list of the loan IDs for which to return detail.
                    • Max list items: 100
                    app_id(string)
                    The application id in reverse DNS notation.

                      Response

                        loan_detail – HTML , JSON , XML , RSS

                      Status

                        Production

                      GET /loans/:id/journal_entries

                      Retrieve journal entries associated with a particular loan.

                      Example

                      http://api.kivaws.org/v1/loans/42939/journal_entries.json

                      Parameters

                      id(number)
                      Required. The ID of the loan for which you want journal entries.
                      page(number)
                      The page position of results to return.
                      • Default: 1
                      app_id(string)
                      The application id in reverse DNS notation.

                        Response

                          journal_entry – HTML , JSON , XML

                        Status

                          Production

                        GET /loans/:id/lenders

                        Returns the list of public lenders to a loan.

                        Example

                        http://api.kivaws.org/v1/loans/38239/lenders.json

                        Parameters

                        id(number)
                        Required. The loan ID for which to return lenders.
                        page(number)
                        The page position of results to return.
                        • Default: 1
                        app_id(string)
                        The application id in reverse DNS notation.
                          ids_only(string)
                          Return IDs only to make the return object smaller.
                          • One of: true, false
                          • Default: false

                          Response

                            lender_listing – HTML , JSON , XML , RSS

                          Status

                            Production

                          GET /loans/:id/repayments

                          Returns the repayment schedule for a loan, including repayments so far

                          Example

                          http://api.kivaws.org/v1/loans/2/repayments.json

                          Parameters

                          id(number)
                          Required. The loan ID for which to return repayments schedule.
                          app_id(string)
                          The application id in reverse DNS notation.
                            ids_only(string)
                            Return IDs only to make the return object smaller.
                            • One of: true, false
                            • Default: false

                            Response

                              loan_listing – HTML , JSON , XML , RSS

                            Status

                              Beta

                            GET /loans/:id/similar

                            Returns loans similar to the specified loan.

                            Example

                            http://api.kivaws.org/v1/loans/2/similar.json

                            Parameters

                            id(number)
                            Required. The loan ID for which to return similar loans.
                            count(number)
                            The amount of similar loans to return.
                            • Default: 3
                            app_id(string)
                            The application id in reverse DNS notation.
                              ids_only(string)
                              Return IDs only to make the return object smaller.
                              • One of: true, false
                              • Default: false

                              Response

                                loan_listing – HTML , JSON , XML , RSS

                              Status

                                Production

                              GET /loans/:id/teams

                              Returns teams that have lent to a particular loan.

                              Example

                              http://api.kivaws.org/v1/loans/613086/teams.json

                              Parameters

                              id(number)
                              Required. The Loan ID for which to return teams.
                              page(number)
                              The page position of results to return.
                              • Default: 1
                              app_id(string)
                              The application id in reverse DNS notation.
                                ids_only(string)
                                Return IDs only to make the return object smaller.
                                • One of: true, false
                                • Default: false

                                Response

                                  team_detail – HTML , JSON , XML , RSS

                                Status

                                  Production

                                GET /loans/:id/updates

                                Returns all status updates for a loan, newest first.

                                The list of updates returned is currently comprised of payment notifications and journal entries. Output for this call is also available as RSS.

                                Example

                                http://api.kivaws.org/v1/loans/42939/updates.json

                                Parameters

                                id(number)
                                Required. The loan ID for which to return updates.
                                app_id(string)
                                The application id in reverse DNS notation.

                                  Response

                                    loan_updates – HTML , JSON , XML , RSS

                                  Status

                                    Production

                                  GET /loans/newest

                                  Returns a simple list of the most recent fundraising loans.

                                  Example

                                  http://api.kivaws.org/v1/loans/newest.json

                                  Parameters

                                  page(number)
                                  The page position of results to return.
                                  • Default: 1
                                  per_page(number)
                                  The page position of results to return.
                                  • Default: 20
                                  app_id(string)
                                  The application id in reverse DNS notation.
                                    ids_only(string)
                                    Return IDs only to make the return object smaller.
                                    • One of: true, false
                                    • Default: false

                                    Response

                                      loan_listing – HTML , JSON , XML , RSS

                                    Status

                                      Production

                                    GET /loans/search

                                    Search and sort loan listings by multiple criteria.

                                    Example

                                    http://api.kivaws.org/v1/loans/search.json

                                    Parameters

                                    status(list of strings)
                                    The status of loans to return.
                                    • One of: fundraising, funded, in_repayment, paid, ended_with_loss
                                    gender(string)
                                    If supplied, results are filtered to loans with entrepreneurs of the specified gender. In the case of group loans, this matches against the predominate gender in the group.
                                    • One of: male, female
                                    region(list of strings)
                                    A list of two-letter codes corresponding to regions in which Kiva operates. If supplied, results are filtered to loans only from the specified regions.
                                    • One of: na, ca, sa, af, as, me, ee, we, an, oc
                                    country_code(list of strings)
                                    A list of two-character ISO codes of countries by which to filter results.
                                    • One of: AF, AL, AM, AZ, BA, BD, BF, BG, BI, BJ, BO, BR, BW, BZ, CD, CG, CI, CL, CM, CO, CR, CV, DO, EC, GE, GH, GT, GZ, HN, HT, ID, IL, IN, IQ, JO, KE, KG, KH, LB, LK, LR, MD, ML, MN, MR, MW, MX, MZ, NA, NG, NI, NP, PA, PE, PG, PH, PK, PS, PY, QS, RW, SL, SN, SO, SR, SV, TD, TG, TH, TJ, TL, TR, TZ, UA, UG, US, VN, VU, WS, XK, YE, ZA, ZM, ZW
                                    sector(list of strings)
                                    A list of business sectors for which to filter results.
                                    • One of: Agriculture, Arts, Clothing, Construction, Education, Entertainment, Food, Health, Housing, Manufacturing, Personal Use, Retail, Services, Transportation, Wholesale
                                    partner(list of numbers)
                                    A list of partner IDs for which to filter results.
                                    theme(list of strings)
                                    A list of themes for which to filter results.
                                    • One of: Green, Higher Education, Arab Youth, Kiva City LA, Islamic Finance, Youth, Start-Up, Water and Sanitation, Vulnerable Groups, Fair Trade, Rural Exclusion, Mobile Technology, Underfunded Areas, Conflict Zones, Job Creation, SME, Growing Businesses, Kiva City Detroit, Disaster recovery
                                    borrower_type(string)
                                    Show individuals, groups or both.
                                    • One of: individuals, groups, both
                                    • Default: both
                                    partner_risk_rating_min(number)
                                    The minimum partner risk.
                                    • Range (inclusive): 0..5
                                    • Default: 0
                                    partner_risk_rating_max(number)
                                    The maximum partner risk.
                                    • Range (inclusive): 0..5
                                    • Default: 5
                                    partner_arrears_min(number)
                                    The minimum partner delinquency.
                                    • Range (inclusive): 0..41
                                    • Default: 0
                                    partner_arrears_max(number)
                                    The maximum partner delinquency.
                                    • Range (inclusive): 0..41
                                    • Default: 41
                                    partner_default_min(number)
                                    The minimum partner default.
                                    • Range (inclusive): 0..26
                                    • Default: 0
                                    partner_default_max(number)
                                    The maximum partner default.
                                    • Range (inclusive): 0..26
                                    • Default: 26
                                    partner_risk_include_nonrated(string)
                                    Include non-rated partners.
                                    • One of: true, false
                                    • Default: true
                                    include_curr_risk(string)
                                    Include partners with currency risk.
                                    • One of: true, false
                                    • Default: true
                                    sort_by(string)
                                    The order by which to sort results.
                                    • One of: popularity, loan_amount, expiration, newest, oldest, amount_remaining, repayment_term, random
                                    • Default: newest
                                    q(string)
                                    A query string against which results should be matched.
                                    page(number)
                                    The page position of results to return.
                                    • Default: 1
                                    per_page(number)
                                    The page position of results to return.
                                    • Default: 20
                                    app_id(string)
                                    The application id in reverse DNS notation.
                                      ids_only(string)
                                      Return IDs only to make the return object smaller.
                                      • One of: true, false
                                      • Default: false

                                      Response

                                        loan_listing – HTML , JSON , XML , RSS

                                      Status

                                        Production

                                      GET /methods

                                      Lists all methods available via the Kiva API.

                                      Example

                                      http://api.kivaws.org/v1/methods.json

                                      Parameters

                                      app_id(string)
                                      The application id in reverse DNS notation.

                                        Response

                                          method_summary – HTML , JSON , XML

                                        Status

                                          Production

                                        GET /methods/:ids

                                        Returns documentation for specific methods of the Kiva API.

                                        Example

                                        http://api.kivaws.org/v1/methods/GET*|loans|newest.json

                                        Parameters

                                        ids(list of strings)
                                        Required. The IDs of methods for which to return specifications.
                                        • Max list items: 50
                                        app_id(string)
                                        The application id in reverse DNS notation.

                                          Response

                                            method_summary – HTML , JSON , XML

                                          Status

                                            Production

                                          GET /my/account

                                          Returns private account information for the Kiva User as authorized.

                                          Requires "access" scope for basic information.

                                          Example

                                          https://api.kivaws.org/v1/my/account.json

                                          Output

                                          { "user_account": { "id": "123456", "is_public": "true", "first_name": "Martin", "last_name": "Johnson", "lender_id": "martin1234" } }

                                          Parameters

                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            user_account – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/balance

                                          Returns private account information for the Kiva User as authorized.

                                          Requires "user_balance" scope for user balance.

                                          Example

                                          https://api.kivaws.org/v1/my/balance.json

                                          Output

                                          { "user_balance": { "id": "123456", "balance": "250.00" } }

                                          Parameters

                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            user_balance – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/email

                                          Returns private account information for the Kiva User as authorized.

                                          Requires "user_email" scope for users email address.

                                          Example

                                          https://api.kivaws.org/v1/my/email.json

                                          Output

                                          { "user_email": { "id": "123456", "email": "martin@lenderweb.org" } }

                                          Parameters

                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            user_email – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/expected_repayments

                                          Returns the expected repayments by month for the Kiva User as authorized

                                          Requires "user_expected_repayments" scope for users email address.

                                          Example

                                          https://api.kivaws.org/v1/my/expected_repayments.json

                                          Output

                                          { "1685602800000": { "user_repayments": "159.01", "promo_repayments": "7.43", "loans_making_repayments": "98","repayment_date": "2015-02-01 00:00:00" } }

                                          Parameters

                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            user_expected_repayments – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/lender

                                          Returns lender object, even for anonymous lenders.

                                          Requires "user_anon_lender_data" scope.

                                          Example

                                          https://api.kivaws.org/v1/my/lender.json

                                          Parameters

                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            lender – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/loans

                                          Returns loans for a lender, even for anonymous lenders.

                                          Requires "user_anon_lender_loans" scope.

                                          Example

                                          https://api.kivaws.org/v1/my/loans.json

                                          Parameters

                                          page(number)
                                          The page position of results to return.
                                          • Default: 1
                                          per_page(number)
                                          The page position of results to return.
                                          • Default: 20
                                          sort_by(string)
                                          The order by which to sort results.
                                          • One of: popularity, loan_amount, oldest, expiration, newest, amount_remaining, repayment_term, random
                                          • Default: newest
                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            loan – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/loans/:ids

                                          Returns detailed information for multiple loans the lender has lent to. Including defaulted and deliquent loans.

                                          Detailed loan records include a lot of data beyond the scope of a loan listing, including the list of borrowers, loan terms, and recorded payments. Requires "user_anon_lender_loans" scope.

                                          Example

                                          https://api.kivaws.org/v1/my/loans/2930.json

                                          Parameters

                                          page(number)
                                          The page position of results to return.
                                          • Default: 1
                                          sort_by(string)
                                          The order by which to sort results.
                                          • One of: popularity, loan_amount, oldest, expiration, newest, amount_remaining, repayment_term, random
                                          • Default: newest
                                          ids(list of numbers)
                                          Required. A list of the loan IDs for which to return detail.
                                          • Max list items: 10
                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            loan_detail – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/loans/:ids/balances

                                          Returns amount lent and outstanding balance for a loan.

                                          Requires "user_loan_balances" scope. Note, the amount_repaid_to_lender is the full expected amount so you have to deduct the currency_loss_to_lender separately to get the actual total repaid. The same is true for the promo amounts. Possible statues: The possible statuses are: refunded, fundraising, expired, funded, in_repayment, paid and ended_with_loss. Loans can have the status 'ended_with_loss' for two reasons. a) currency loss, which will be presented in the return values or b) default, which is the remainder when the numbers don't add up.

                                          Example

                                          https://api.kivaws.org/v1/my/loans/:ids/balances.json

                                          Output

                                          { "balances" : { "id": "449097", "total_amount_purchased": "25", "amount_repaid_to_lender": "0", "currency_loss_to_lender": "0", "amount_repaid_to_promo": "6.51", "currency_loss_to_promo": "0", "arrears_amount": "0", "status": "in_repayment" } }

                                          Parameters

                                          ids(string)
                                          Required. none
                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            user_loan_balances – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /my/stats

                                          Returns statistics about the lender.

                                          A list of statistics about the lenders loans, donations, etc. Requires "user_stats" scope.

                                          Example

                                          https://api.kivaws.org/v1/my/stats.json

                                          Parameters

                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            user_stats – HTML , JSON , XML

                                          Status

                                            Beta

                                          Requires OAuth

                                          GET /my/teams

                                          Returns teams for a lender, even for anonymous lenders.

                                          Requires "user_anon_lender_teams" scope.

                                          Example

                                          https://api.kivaws.org/v1/my/teams.json

                                          Parameters

                                          page(number)
                                          The page position of results to return.
                                          • Default: 1
                                          sort_by(string)
                                          The order by which to sort results.
                                          • One of: newest, oldest, member_count, loan_count, loaned_amount, query_relevance
                                          • Default: newest
                                          app_id(string)
                                          A unique developer-defined Application ID, usually in reverse DNS notation.

                                          Response

                                            team – HTML , JSON , XML

                                          Status

                                            Production

                                          Requires OAuth

                                          GET /partners

                                          Returns detailed listings for all Kiva field partners.

                                          Example

                                          http://api.kivaws.org/v1/partners.json

                                          Parameters

                                          page(number)
                                          The page position of results to return.
                                          • Default: 1
                                          app_id(string)
                                          The application id in reverse DNS notation.

                                            Response

                                              partner_listing – HTML , JSON , XML , RSS

                                            Status

                                              Production

                                            GET /partners/:ids

                                            Returns detailed information about one or more partners.

                                            Example

                                            http://api.kivaws.org/v1/partners/2.json

                                            Parameters

                                            ids(list of numbers)
                                            Required. A list of partner IDs for which to return partner detail.
                                            • Max list items: 20
                                            app_id(string)
                                            The application id in reverse DNS notation.

                                              Response

                                                partner_listing – HTML , JSON , XML , RSS

                                              Status

                                                Production

                                              GET /releases/api/current

                                              Returns versioning information on the current Kiva API release.

                                              Example

                                              http://api.kivaws.org/v1/releases/api/current.json

                                              Parameters

                                              app_id(string)
                                              The application id in reverse DNS notation.

                                                Response

                                                  release – HTML , JSON , XML

                                                Status

                                                  Production

                                                GET /statistics/journal_entries/:stat_name

                                                Returns statistics related to Journal Entries.

                                                Example

                                                http://api.kivaws.org/v1/statistics/journal_entries/average_comments.json

                                                Parameters

                                                page(number)
                                                The page position of results to return.
                                                • Default: 1
                                                app_id(string)
                                                The application id in reverse DNS notation.
                                                  start(number)
                                                  Start date for the data range as a UNIX timestamp.
                                                    end(number)
                                                    End date for the data range as a UNIX timestamp.
                                                      period(string)
                                                      Period of granularity to section the data.
                                                      • One of: cumulative, year, quarter, month, week, day, hour
                                                      stat_name(string)
                                                      Required. Statistic to return.
                                                      • One of: average_comments, average_recommendations
                                                      aggregate(string)
                                                      Argument to aggregate results by.
                                                      • One of: partner_id
                                                      partner_id(number)
                                                      Partner ID to limit results by.
                                                        is_rate_eligible(string)
                                                        • One of: true, false

                                                        Response

                                                          statistic – HTML , JSON , XML

                                                        Status

                                                          Beta

                                                        GET /statistics/lenders/:stat_name

                                                        Returns statistics related to Lenders.

                                                        Example

                                                        http://api.kivaws.org/v1/statistics/lenders/count_lenders.json

                                                        Parameters

                                                        page(number)
                                                        The page position of results to return.
                                                        • Default: 1
                                                        app_id(string)
                                                        The application id in reverse DNS notation.
                                                          start(number)
                                                          Start date for the data range as a UNIX timestamp.
                                                            end(number)
                                                            End date for the data range as a UNIX timestamp.
                                                              period(string)
                                                              Period of granularity to section the data.
                                                              • One of: cumulative, year, quarter, month, week, day, hour
                                                              stat_name(string)
                                                              Required. Statistic to return.
                                                              • One of: count_logins, count_lenders, average_loans_per_lender, average_total_loaned_per_lender, average_loans_per_login, average_total_loaned_per_login

                                                              Response

                                                                statistic – HTML , JSON , XML

                                                              Status

                                                                Beta

                                                              GET /statistics/loans/:stat_name

                                                              Returns statistics related to Loans.

                                                              Example

                                                              http://api.kivaws.org/v1/statistics/loans/count.json

                                                              Parameters

                                                              page(number)
                                                              The page position of results to return.
                                                              • Default: 1
                                                              app_id(string)
                                                              The application id in reverse DNS notation.
                                                                start(number)
                                                                Start date for the data range as a UNIX timestamp.
                                                                  end(number)
                                                                  End date for the data range as a UNIX timestamp.
                                                                    period(string)
                                                                    Period of granularity to section the data.
                                                                    • One of: cumulative, year, quarter, month, week, day, hour
                                                                    stat_name(string)
                                                                    Required. Statistic to return.
                                                                    • One of: total, count, average_per_entrep, num_entreps, gender_num_male, gender_num_female, gender_num_specified
                                                                    aggregate(string)
                                                                    Argument to aggregate results by.
                                                                    • One of: partner_id, gender
                                                                    partner_id(number)
                                                                    Partner ID to limit results by.
                                                                      country_code(list of strings)
                                                                      A list of two-character ISO codes of countries by which to filter results.
                                                                      • One of: AF, AL, AM, AZ, BA, BD, BF, BG, BI, BJ, BO, BR, BW, BZ, CD, CG, CI, CL, CM, CO, CR, CV, DO, EC, GE, GH, GT, GZ, HN, HT, ID, IL, IN, IQ, JO, KE, KG, KH, LB, LK, LR, MD, ML, MN, MR, MW, MX, MZ, NA, NG, NI, NP, PA, PE, PG, PH, PK, PS, PY, QS, RW, SL, SN, SO, SR, SV, TD, TG, TH, TJ, TL, TR, TZ, UA, UG, US, VN, VU, WS, XK, YE, ZA, ZM, ZW
                                                                      is_raised(string)
                                                                      • One of: true, false
                                                                      is_refunded(string)
                                                                      • One of: true, false
                                                                      is_ended(string)
                                                                      • One of: true, false

                                                                      Response

                                                                        statistic – HTML , JSON , XML

                                                                      Status

                                                                        Beta

                                                                      GET /statistics/partners/:stat_name

                                                                      Returns statistics related to Partners.

                                                                      Example

                                                                      http://api.kivaws.org/v1/statistics/partners/count.json

                                                                      Parameters

                                                                      page(number)
                                                                      The page position of results to return.
                                                                      • Default: 1
                                                                      app_id(string)
                                                                      The application id in reverse DNS notation.
                                                                        start(number)
                                                                        Start date for the data range as a UNIX timestamp.
                                                                          end(number)
                                                                          End date for the data range as a UNIX timestamp.
                                                                            period(string)
                                                                            Period of granularity to section the data.
                                                                            • One of: cumulative, year, quarter, month, week, day, hour
                                                                            stat_name(string)
                                                                            Required. Statistic to return.
                                                                            • One of: count, countries
                                                                            aggregate(string)
                                                                            Argument to aggregate results by.
                                                                            • One of: partner_id
                                                                            is_current_partner(string)
                                                                            • One of: true

                                                                            Response

                                                                              statistic – HTML , JSON , XML

                                                                            Status

                                                                              Beta

                                                                            GET /statistics/teams/:stat_name

                                                                            Returns statistics related to Teams.

                                                                            Example

                                                                            http://api.kivaws.org/v1/statistics/teams/total_members.json

                                                                            Parameters

                                                                            page(number)
                                                                            The page position of results to return.
                                                                            • Default: 1
                                                                            app_id(string)
                                                                            The application id in reverse DNS notation.
                                                                              start(number)
                                                                              Start date for the data range as a UNIX timestamp.
                                                                                end(number)
                                                                                End date for the data range as a UNIX timestamp.
                                                                                  period(string)
                                                                                  Period of granularity to section the data.
                                                                                  • One of: cumulative, year, quarter, month, week, day, hour
                                                                                  stat_name(string)
                                                                                  Required. Statistic to return.
                                                                                  • One of: total_members
                                                                                  team_id(number)
                                                                                  Required. Team ID to limit results by.

                                                                                    Response

                                                                                      statistic – HTML , JSON , XML

                                                                                    Status

                                                                                      Beta

                                                                                    GET /teams/:ids

                                                                                    Returns detailed information about one or more lending teams.

                                                                                    Example

                                                                                    http://api.kivaws.org/v1/teams/2.json

                                                                                    Parameters

                                                                                    ids(list of numbers)
                                                                                    Required. A list of team IDs for which to return team detail.
                                                                                    • Max list items: 20
                                                                                    app_id(string)
                                                                                    The application id in reverse DNS notation.

                                                                                      Response

                                                                                        team_detail – HTML , JSON , XML , RSS

                                                                                      Status

                                                                                        Production

                                                                                      GET /teams/:id/lenders

                                                                                      Returns the list of public lenders belonging to a specific team.

                                                                                      Example

                                                                                      http://api.kivaws.org/v1/teams/2/lenders.json

                                                                                      Parameters

                                                                                      id(number)
                                                                                      Required. The numeric team ID for which to return lenders.
                                                                                      sort_by(string)
                                                                                      The order by which to sort results.
                                                                                      • One of: oldest, newest
                                                                                      • Default: newest
                                                                                      page(number)
                                                                                      The page position of results to return.
                                                                                      • Default: 1
                                                                                      app_id(string)
                                                                                      The application id in reverse DNS notation.
                                                                                        ids_only(string)
                                                                                        Return IDs only to make the return object smaller.
                                                                                        • One of: true, false
                                                                                        • Default: false

                                                                                        Response

                                                                                          lender_listing – HTML , JSON , XML , RSS

                                                                                        Status

                                                                                          Production

                                                                                        GET /teams/:id/loans

                                                                                        Returns loans belonging to a particular team.

                                                                                        Example

                                                                                        http://api.kivaws.org/v1/teams/2/loans.json

                                                                                        Parameters

                                                                                        id(number)
                                                                                        Required. The team ID for which to return loans.
                                                                                        page(number)
                                                                                        The page position of results to return.
                                                                                        • Default: 1
                                                                                        sort_by(string)
                                                                                        The order by which to sort results.
                                                                                        • One of: oldest, newest
                                                                                        • Default: newest
                                                                                        app_id(string)
                                                                                        The application id in reverse DNS notation.
                                                                                          ids_only(string)
                                                                                          Return IDs only to make the return object smaller.
                                                                                          • One of: true, false
                                                                                          • Default: false

                                                                                          Response

                                                                                            loan_listing – HTML , JSON , XML , RSS

                                                                                          Status

                                                                                            Production

                                                                                          GET /teams/search

                                                                                          Sort through the list of lending teams using multiple criteria.

                                                                                          Example

                                                                                          http://api.kivaws.org/v1/teams/search.json

                                                                                          Parameters

                                                                                          membership_type(string)
                                                                                          If supplied, only teams with the specified membership policy are returned.
                                                                                          • One of: open, closed
                                                                                          category(string)
                                                                                          If supplied, only teams with the specified category are returned.
                                                                                          • One of: Alumni Groups, Businesses, Businesses - Internal Groups, Clubs, Colleges/Universities, Common Interest, Events, Families, Field Partner Fans, Friends, Local Area, Memorials, Religious Congregations, Schools, Sports Groups, Youth Groups, Other
                                                                                          sort_by(string)
                                                                                          The order by which to sort results.
                                                                                          • One of: newest, oldest, member_count, loan_count, loaned_amount, query_relevance
                                                                                          • Default: newest
                                                                                          page(number)
                                                                                          The page position of results to return.
                                                                                          • Default: 1
                                                                                          q(string)
                                                                                          A query string by which to match results.
                                                                                          app_id(string)
                                                                                          The application id in reverse DNS notation.
                                                                                            ids_only(string)
                                                                                            Return IDs only to make the return object smaller.
                                                                                            • One of: true, false
                                                                                            • Default: false

                                                                                            Response

                                                                                              team_listing – HTML , JSON , XML , RSS

                                                                                            Status

                                                                                              Production

                                                                                            GET /teams/using_shortname/:shortnames

                                                                                            Returns detailed information about one or more teams, identified by shortname.

                                                                                            Usually data about teams is retrieved using the team‘s numerical ID. This method is useful for looking up that ID and other information when only the shortname of the team is known.

                                                                                            Example

                                                                                            http://api.kivaws.org/v1/teams/using_shortname/buildkiva.json

                                                                                            Parameters

                                                                                            shortnames(list of strings)
                                                                                            Required. A list of team shortnames for which to return team detail.
                                                                                            • Max list items: 20
                                                                                            app_id(string)
                                                                                            The application id in reverse DNS notation.
                                                                                              ids_only(string)
                                                                                              Return IDs only to make the return object smaller.
                                                                                              • One of: true, false
                                                                                              • Default: false

                                                                                              Response

                                                                                                team_detail – HTML , JSON , XML

                                                                                              Status

                                                                                                Production

                                                                                              GET /templates/images

                                                                                              Lists all URL templates useful for fetching images on Kiva.

                                                                                              Example

                                                                                              http://api.kivaws.org/v1/templates/images.json

                                                                                              Parameters

                                                                                              app_id(string)
                                                                                              The application id in reverse DNS notation.

                                                                                                Response

                                                                                                  image_template – HTML , JSON , XML

                                                                                                Status

                                                                                                  Production

                                                                                                Kiva
                                                                                                • © 2009 - 2014 Kiva. All rights reserved.
                                                                                                • Terms Of Service
                                                                                                • Kiva is a 501(c)(3) nonprofit.