Automated Offer Feed
Overview
The Automated Offer Feed via our Link Search API is an API that enables you to access specific credit card content, links and images from our financial advertisers. The link output is recommended for mapping to your Content Management System, and we recommend that you seek Advertiser approval prior to putting it into production.
The Link Search Service is a REST API that enables publishers to find links based on desired criteria. All parameter names and values are not case sensitive. You must provide at least one of the optional parameters. Submitting an empty request does not return all possible results; an empty request returns zero results.
Limits
Call limit: 25 calls per minute
Call restrictions: Publishers only
Request
GET https<no-link>://link-search.api.cj.com/v2/link-search
Sample Request
See the Authentication Overview for information on how to authenticate API calls.
curl -s XGET "https://link-search.api.cj.com/v2/link-search?website-id=[YOUR WEBSITE ID HERE]&advertiser-ids=[ADVERTISER ID HERE]&link-type=Content%20Link&records-per-page=100" -H "Authorization: Bearer <your-personal-access-token>"Request Query Parameters
If you would like to customize further please refer to the Link Search API request parameters.
Response
Response Elements
The response includes the following information about the overall set of results in the response.
General
| Parameter Name | Description |
|---|---|
| links | An array of link records. See the Per Record (Link) table for the fields returned for each link record in the response. |
| total-results | The total number of matching results in the index, regardless of the number of results in the actual response (the value of the max-results parameter). |
Per Record (Link)
The response includes the following fields for each record (i.e., link). The fields below serve as an example only.
| Parameter Name | Description |
|---|---|
| cardName | The name of the card/offer, verbatim including registration/trademarks. Please make sure all symbols are HTML encoded. |
| processingNetwork | MasterCard/Visa/American Express/ Discover. Please make sure all symbols are HTML encoded. |
| productType | Consumer, Business, etc. |
| cardType | CoBrand, Lending, Mileage, Rewards, etc. |
| creditRating | Excellent, Good, etc. |
| introPurchAPR | How introductory purchase APR should be displayed |
| introPurchAPRValue | Introductory purchase APR value |
| introPurchAPRType | Introductory purchase APR type |
| introPurchAPRPeriod | How introductory purchase APR period should be displayed |
| introPurchAPRPeriodValue | Introductory purchase APR period value |
| introPurchAPRPeriodType | Introductory purchase APR period type |
| nonIntroPurchAPR | How non-introductory purchase APR should be displayed |
| nonIntroPurchAPRValue | Non-introductory purchase APR value |
| nonIntroPurchAPRType | Non-introductory purchase APR type |
| purchGracePeriod | How Purchase grace period should be displayed |
| purchGracePeriodValue | Purchase grace period value |
| purchGracePeriodType | Purchase grace period type |
| introTransferAPR | How introductory transfer APR should be displayed |
| introTransferAPRValue | Introductory transfer APR value |
| introTransferAPRType | Introductory transfer APR type |
| introTransAPRPeriod | How introductory transfer APR period should be displayed |
| introTransAPRPeriodValue | Introductory transfer APR period value |
| introTransAPRPeriodType | Introductory transfer APR period type |
| nonIntroTransAPR | How non-introductory transfer APR should be displayed |
| nonIntroTransAPRValue | Non-introductory transfer APR value |
| nonIntroTransAPRType | Non-introductory transfer APR type |
| transferGracePeriod | How transfer grace period should be displayed |
| transferGracePeriodValue | Transfer grace period value |
| transferGracePeriodType | Transfer grace period type |
| cashAdvanceAPR | How cash advance APR should be displayed |
| cashAdvanceAPRValue | Cash advance APR value |
| cashAdvanceAPRType | Cash advance APR type |
| penaltyAPR | How penalty APR should be displayed |
| penaltyAPRValue | Penalty APR value |
| penaltyAPRType | Penalty APR type |
| cashGracePeriod | How cash grace period should be displayed |
| cashGracePeriodValue | Cash grace period value |
| cashGracePeriodType | Cash grace period type |
| balanceTransFee | How balance transfer fee should be displayed |
| balanceTransFeeValue | Balance transfer fee value |
| cashAdvanceFee | How cash advance fee should be displayed |
| cashAdvanceFeeValue | Cash advance fee value |
| latePaymentFee | How late payment fee should be displayed |
| latePaymentFeeValue | Late payment fee value |
| returnPaymentFee | How return payment fee should be displayed. |
| returnPaymentFeeValue | Return payment fee value |
| overLimitFee | How over limit fee should be displayed. |
| overLimitFeeValue | Over limit fee value |
| foreignTransFee | How foreign transaction fee should be displayed |
| foreignTransFeeValue | Foreign transaction fee value |
| introAnnualMemFee | How introductory annual member fee should be displayed |
| introAnnualMemFeeValue | Introductory annual member fee value |
| introAnnualMemFeePeriod | How introductory annual member fee period should be displayed |
| introAnnualMemFeePeriodValue | Introductory annual member fee period value |
| introAnnualMemFeePeriodType | Introductory annual member fee period type |
| annualMemFee | How annual member fee should be displayed |
| annualMemFeeValue | Annual member fee value |
| minimumDeposit | How minimum deposit should be displayed |
| Categories | Relevant card categories |
| marketingCopy | How marketing copy should be displayed. Please make sure all bullets are HTML encoded. |
| mobileCopy | How mobile marketing copy should be displayed. Please make sure all bullets are HTML encoded. |
| additionalCopy | How additional copy should be displayed. Please make sure all bullets are HTML encoded. |
| customPromotion | How custom promotion should be displayed |
| availableApplications | List of available supported applications. |
| rewardsRate1 | Numeric value of rewards. If relevant, number should be paired with the appropriate symbol. ($, %, etc.) |
| rewardsType1 | Reward type, must be verbatim |
| rewardsRate1Terms | Reward rate terms, must be verbatim |
| rewardsRate2 | Numeric value of rewards. If relevant, number should be paired with the appropriate symbol. ($, %, etc.) |
| rewardsType2 | Reward type, must be verbatim |
| rewardsRate2Terms | Reward rate terms, must be verbatim |
| rewardsRate3 | Numeric value of rewards. If relevant, number should be paired with the appropriate symbol. ($, %, etc.) |
| rewardsType3 | Reward type, must be verbatim |
| rewardsRate3Terms | Reward rate terms, must be verbatim |
| rewardsRate4 | Numeric value of rewards. If relevant, number should be paired with the appropriate symbol. ($, %, etc.) |
| rewardsType4 | Reward type, must be verbatim |
| rewardsRate4Terms | Reward rate terms, must be verbatim |
| rewardsBonus | Numeric value of rewards. If relevant, number should be paired with the appropriate symbol. ($, %, etc.) |
| rewardsBonusTerms | Reward bonus terms, must be verbatim |
| prohibitedCategories | List of non-approved categories |
| recommendedSiteType | List of recommended or approved site types |
| detailsRatesFeesUrl | URL for terms and additional details |
| regularAPR | How regular APR should be displayed |
| regularAPRValue | Regular APR value |
| regularAPRType | Regular APR type |
Errors
REST Errors For All APIs
The HTTP Response Code for the following errors is 401.
| Message | Description |
|---|---|
| None | Incorrect resource URL |
| "You must specify a developer key." | No developer key specified |
| "Not Authenticated: xxxxxx" (where xxxxxx is the echo of the developer key used). | Invalid developer key specified |
Updated 9 days ago