Skip to main content
Documentation Powered by Redocly

Reference (1.0.0)

Download OpenAPI specification:Download

PraiseCharts: developers@praisecharts.com URL: https://praisecharts.com/ Terms of Service

PraiseCharts API public endpoints

OAuth

Request Token

Allows a Consumer application to obtain an OAuth Request Token to request user authorization.

This method fulfills Section 6.1 of the OAuth 1.0 authentication flow.

This request MUST be signed and include the following in the Authorization header

OAuth oauth_consumer_key="xvz1evFS4wEEPTGEFPHBog", 
oauth_nonce="kYjzVBB8Y0ZFabxSWbWovY3uYSQ2pTgmZeNu2VS4cg",
oauth_signature="tnnArxj06cWHq44gCs1OSKk%2FjLY%3D",
oauth_signature_method="HMAC-SHA1",
oauth_timestamp="1318622958",
oauth_version="1.0"

See how to create a signature

Authorizations:
Authorization
header Parameters
Authorization
required
string
Example: OAuth oauth_nonce="K7ny27JTpKVsTgdyLdDfmQQWVLERj2zAK5BslRsqyw", oauth_callback="http://myapp.com:3005/twitter/process_callback", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1300228849", oauth_consumer_key="OqEqJeafRSF11jBMStrZz", oauth_signature="Pc+MLdv028fxCErFyi8KXFM+ddU=", oauth_version="1.0"`

Signed OAuth string

Responses

Response samples

Content type
application/json
{
  • "oauth_token": "ab079985927a23793f41170194c1b3",
  • "oauth_token_secret": "747ce9c680",
  • "oauth_callback_confirmed": true
}

Authorize

Allows a Consumer application to use an OAuth Request Token to request user authorization. This method fulfills Section 6.2 of the OAuth 1.0 authentication flow.

query Parameters
oauth_token
required
string
Example: oauth_token=3756b0ec8c0e232123623f761b5017

unauthorized oauth_token generated from /oauth/request_token

Responses

Access token

Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token.

This method fulfills Section 6.3 of the OAuth 1.0 authentication flow.

This request MUST be signed per Signing Requests and include the following:

OAuth oauth_consumer_key="xvz1evFS4wEEPTGEFPHBog", 
oauth_nonce="kYjzVBB8Y0ZFabxSWbWovY3uYSQ2pTgmZeNu2VS4cg",
oauth_signature="tnnArxj06cWHq44gCs1OSKk%2FjLY%3D",
oauth_signature_method="HMAC-SHA1",
oauth_timestamp="1318622958",
oauth_token="370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb",
oauth_verifier="aa4bf7d3250f45a4eb4549be9fbde8",
oauth_version="1.0"

See how to create a signature

Authorizations:
Authorization
header Parameters
Authorization
required
string
Example: OAuth oauth_consumer_key="acg", oauth_nonce="c1f9a3b8e83e0fe7d12ff201b0f68089", oauth_signature="jquFmwtxfTM49wddcuAsxjjYa/I=", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1318622958", oauth_token="3756b0ec8c0e232123623f761b5017", oauth_verifier="aa4bf7d3250f45a4eb4549be9fbde8", oauth_version="1.0"

Responses

Response samples

Content type
application/json
"string"

Catalog

Search Catalog

Search Guide

Authorizations:
Authorization
query Parameters
q
string

Your search query.

For accurate results search {song title} {artist name}

The query field searches against title, author names, artist names, album name, themes PCID, CCLI, Product name, and more.

product_types[]
Array of strings
Items Enum: "sheet_music" "audio_tracks" "patches"

Will only return products of the specified type.

If a song matches the query but doesn't have the specified type. items[x].products will be empty.

Allowed values: 'sheet_music' 'audio_tracks' 'patches'

Defaults to all.

ccli_number
number
themes[]
Array of strings
keys[]
Array of strings
product_codes[]
Array of strings
search_lyrics
boolean

If true, will apply search term against lyrics as well as other fields.

Defaults to false.

exists
string

Specify a property that must contain a truthy value for the product to be returned.

For example, if you want to return only products that have a Tempo, you would use exists=details.tempo.

If the product doesn't have the specified property, it will be excluded from the results.

arr_includes[]
Array of strings

pass in an array of strings that represent what parts of the model you want back.

Example:

arr_includes[]='id'

arr_includes[]=“details.title'

arr_includes[]='details.artists.names'

arr_includes[]=“details.album.images.md.url'

Would only return those fields in the response.

limit
number

The maximum number of results to return in each item type.

Default value: 10

Example value: 20

from
number

The index of the first result to return. Use with limit for pagination.

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "arrangements": {
    }
}

Library

Search Library

Search Guide

Authorizations:
Authorization
query Parameters
q
string

Your search query.

For accurate results search {song title} {artist name}

The query field searches against title, author names, artist names, album name, themes PCID, CCLI, Product name, and more.

product_types[]
Array of strings
Items Enum: "sheet_music" "audio_tracks" "patches"

Will only return products of the specified type.

If a song matches the query but doesn't have the specified type. items[x].products will be empty.

Allowed values: 'sheet_music' 'audio_tracks' 'patches'

Defaults to all.

ccli_number
number
themes[]
Array of strings
keys[]
Array of strings
product_codes[]
Array of strings
search_lyrics
boolean

If true, will apply search term against lyrics as well as other fields.

Defaults to false.

exists
string

Specify a property that must contain a truthy value for the product to be returned.

For example, if you want to return only products that have a Tempo, you would use exists=details.tempo.

If the product doesn't have the specified property, it will be excluded from the results.

arr_includes[]
Array of strings

pass in an array of strings that represent what parts of the model you want back.

Example:

arr_includes[]='id'

arr_includes[]=“details.title'

arr_includes[]='details.artists.names'

arr_includes[]=“details.album.images.md.url'

Would only return those fields in the response.

limit
number

The maximum number of results to return in each item type.

Default value: 10

Example value: 20

from
number

The index of the first result to return. Use with limit for pagination.

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "in_library": {
    },
  • "other_results": {
    }
}

Import Arrangement

Get an array of simple objects representing all of the files the user has access to organized by key

Figma Example

Authorizations:
Authorization
path Parameters
catalog_item_id
required
string
Example: 73318

Catalog Item ID

query Parameters
keys[]
Array of strings
Example: keys[]=G

Keys

Responses

Response samples

Content type
application/json
{}

Download

Download

The download route uses a different Base URL https://api.praisecharts.com/

Array paramaters need to be passed in using PHP array syntaxt. ie: ?key[]=value&?key[]=value

Download Guide

Authorizations:
Authorization
query Parameters
skus
required
Array of strings
keys
Array of strings

Key Names

key_ids
Array of strings

Key Ids

chordpro_option
string
Example: chordpro_option=cc_1col_pdf

default: cc_2col_pdf default

Responses

User

Account

Returns an object of the current user's account information

Authorizations:
Authorization
header Parameters
Authorization
required
string
Example: OAuth oauth_nonce="K7ny27JTpKVsTgdyLdDfmQQWVLERj2zAK5BslRsqyw", oauth_callback="http://myapp.com:3005/twitter/process_callback", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1300228849", oauth_consumer_key="OqEqJeafRSF11jBMStrZz", oauth_signature="Pc+MLdv028fxCErFyi8KXFM+ddU=", oauth_version="1.0"`

Signed OAuth string

Responses